numeric-utils 2.1.0 → 2.1.1

package/dist/mod.js

@@ -1,659 +1,2 @@
-/**
- * A great set of utilities for interacting with numbers. Serving 36 functions.
- * @author [ZakaHaceCosas](https://github.com/ZakaHaceCosas/)
- *
- * @example
- * ```ts
- * import { average } from "@zakahacecosas/number-utils";
- *
- * const grades = [5, 7, 4, 9, 5, 6.1];
- * const averageGrade = average(grades); // get the avg
- * return `You scored an average of ${averageGrade}`;
- * ```
- *
- * @example
- * ```ts
- * import { roundTo, min, max } from "@zakahacecosas/number-utils";
- *
- * function analyzeWages(wages: number[]) {
- *   const avgWage = roundTo(average(avgWage), 2);
- *   const highestWage = max(avgWage);
- *   const lowestWage = min(avgWage);
- *
- *   console.log(`Average wage: ${avgWage}€`);
- *   console.log(`Highest wage: ${highestWage}€`);
- *   console.log(`Lowest wage: ${lowestWage}€`);
- * }
- *
- * const wages = [1800, 2200, 2500, 1900, 2750];
- * analyzeWages(wages);
- * ```
- *
- * @module
- */
-// * SECTION: MODULE * //
-/**
- * Converts degrees to radians.
- *
- * @param {number} deg Degrees.
- *
- * @example
- * ```ts
- * degreesToRadians(180); // 3.141592653589793
- * ```
- *
- * @returns {number} Radians.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export function degreesToRadians(deg) {
-    return (deg * Math.PI) / 180;
-}
-/**
- * Converts radians to degrees.
- *
- * @param {number} rad Radians.
- *
- * @example
- * ```ts
- * radiansToDegrees(Math.PI); // 180
- * ```
- *
- * @returns {number} Degrees.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export function radiansToDegrees(rad) {
-    return (rad * 180) / Math.PI;
-}
-/**
-   * Converts kilometers to miles.
-   *
-   * @param {number} km Kilometers.
-   *
-   * @example
-   * ```ts
-   * kilometersToMiles(5); // 3.106855
-   * ```
-      * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
-
-   * @returns {number} Miles.
-   */
-export function kilometersToMiles(km) {
-    return km * 0.621371;
-}
-/**
- * Converts miles to kilometers.
- *
- * @param {number} miles Miles.
- *
- * @example
- * ```ts
- * milesToKilometers(5); // 8.046722
- * ```
- *
- * @returns {number} Degrees.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export function milesToKilometers(miles) {
-    return miles / 0.621371;
-}
-/**
- * Converts meters to feet.
- *
- * @param {number} meters Meters.
- *
- * @example
- * ```ts
- * metersToFeet(5); // 16.4042
- * ```
- *
- * @returns {number} Feet.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export function metersToFeet(meters) {
-    return meters * 3.28084;
-}
-/**
- * Converts feet to meters.
- *
- * @param {number} feet Feet.
- *
- * @example
- * ```ts
- * feetToMeters(5); // 1.524
- * ```
- *
- * @returns {number} Meters.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export function feetToMeters(feet) {
-    return feet / 3.28084;
-}
-/**
- * _A classic._ Checks if a given number is even or not. Analog to {@linkcode isOdd}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isEven(2); // true
- * isEven(3); // false
- * ```
- *
- * @returns {boolean} True if it's even, false if otherwise.
- */
-export function isEven(num) {
-    return num % 2 === 0;
-}
-/**
- * _A classic._ Checks if a given number is odd or not. Analog to {@linkcode isEven}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isOdd(2); // false
- * isOdd(3); // true
- * ```
- *
- * @returns {boolean} True if it's odd, false if otherwise.
- */
-export function isOdd(num) {
-    return num % 2 !== 0;
-}
-/**
- * Rounds a given number to a specified decimal precision.
- *
- * @param {number} num Number to round.
- * @param {number} [precision=0] Amount of decimals to include. Defaults to 0.
- *
- * @example
- * ```ts
- * roundTo(3.14159, 2) // 3.14
- * ```
- *
- * @returns {number} The rounded number.
- */
-export function roundTo(num, precision = 0) {
-    return Number(num.toFixed(precision));
-}
-/**
- * Generates a random integer between min and max (inclusive).
- *
- * @param {number} min Minimum number, inclusive.
- * @param {number} max Maximum number, inclusive.
- *
- * @example
- * ```ts
- * random(1, 10)   // returns a random num between 1 and 10, e.g. "7"
- * random(65, 105) // returns a random num between 65 and 105, e.g. "81"
- * ```
- *
- * @returns {number} A random number between `min` and `max`.
- */
-export function random(min, max) {
-    return Math.floor(Math.random() * (max - min + 1)) + min;
-}
-/**
- * Checks if a given number is prime.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isPrime(7) // true
- * isPrime(8) // false
- * ```
- *
- * @returns {boolean} True if the given number is prime, false if otherwise.
- */
-export function isPrime(num) {
-    if (num < 2)
-        return false;
-    for (let i = 2; i <= Math.sqrt(num); i++) {
-        if (num % i === 0)
-            return false;
-    }
-    return true;
-}
-/**
- * Returns the n-th prime number. **Computationally expensive.**
- *
- * @export
- * @param {number} index Index of the prime number, as in a JS array. Index 0 is number 2, for example.
- *
- * @example
- * ```ts
- * primeAt(0); // 2
- * primeAt(3); // 7
- * primeAt(9999999999); // your PC has likely crashed at this point
- * ```
- *
- * @returns {number} The prime number at the given index.
- */
-export function primeAt(index) {
-    if (index < 0)
-        throw new Error("Index must be a non-negative integer.");
-    const primes = [];
-    let c = 0;
-    let i = 0;
-    while (primes.length <= index) {
-        console.log(primes);
-        if (isPrime(c)) {
-            primes.push(c);
-            i++;
-        }
-        c++;
-    }
-    return primes[index];
-}
-/**
- * Returns the sum of all numbers in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * sumArray([1, 2, 3]) // 6
- * ```
- *
- * @returns {number} The sum of all numbers in the array.
- */
-export function sumArray(arr) {
-    return arr.reduce((acc, curr) => acc + curr, 0);
-}
-/**
- * Returns the average of all numbers in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * average([1, 2, 3, 4]) // 2.5
- * ```
- *
- * @returns {number} The average of all numbers in the array.
- */
-export function average(arr) {
-    return sumArray(arr) / arr.length;
-}
-/**
- * Checks if a given number is between two numbers, both of them inclusive.
- *
- * @param {number} num Number to check.
- * @param {number} min Minimum number. Inclusive.
- * @param {number} max Maximum number. Inclusive.
- *
- * @example
- * ```ts
- * isBetween(5, 1, 10); // true
- * isBetween(15, 1, 10); // false
- * ```
- *
- * @returns {boolean} True if the number is between `min` and `max`, false if otherwise.
- */
-export function isBetween(num, min, max) {
-    return num >= min && num <= max;
-}
-/**
- * Calculates the factorial of a number. For reference, the factorial of `n` (`n!`), is multiplying that number by each number below of it and above zero.
- *
- * @param {number} num Number to calculate the factorial for.
- *
- * @example
- * ```ts
- * factorial(5) // 120, since 5 * 4 * 3 * 2 * 1 = 120
- * ```
- *
- * @returns {number} The factorial of the given number.
- */
-export function factorial(num) {
-    return (num <= 1 ? 1 : num * factorial(num - 1));
-}
-/**
- * Checks if a number is a perfect square. For reference, a perfect square is a number that, when squared, returns an exact value.
- *
- * @param {number} num Number to check for.
- *
- * @example
- * ```ts
- * isPerfectSquare(16); // true
- * isPerfectSquare(18); // false
- * ```
- *
- * @returns {boolean} True if it's a perfect square, false if otherwise.
- */
-export function isPerfectSquare(num) {
-    return Number.isInteger(Math.sqrt(num));
-}
-/**
- * Finds the greatest common divisor (GCD) of two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * gcd(12, 18); // 6.
- * ```
- *
- * @returns {number} The GCD of both numbers.
- */
-export function gcd(a, b) {
-    while (b !== 0) {
-        const temp = b;
-        b = a % b;
-        a = temp;
-    }
-    return a;
-}
-/**
- * Finds the least common multiple (LCM) of two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * lcm(12, 18); // 36.
- * ```
- *
- * @returns {number} The LCM of both numbers.
- */
-export function lcm(a, b) {
-    return (a * b) / gcd(a, b);
-}
-/**
- * Returns the absolute difference between two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * absDiff(10, 3); // 7
- * ```
- *
- * @returns {number} Their absolute difference.
- */
-export function absDiff(a, b) {
-    return Math.abs(a - b);
-}
-/**
- * _A classic._ Checks if a given number is negative or not. Analog to {@linkcode isPositive}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isNegative(-2); // true
- * isNegative(3);  // false
- * ```
- *
- * @returns {boolean} True if it's negative, false if otherwise.
- */
-export function isNegative(num) {
-    return num < 0;
-}
-/**
- * _A classic._ Checks if a given number is positive or not. Analog to {@linkcode isNegative}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isPositive(-2); // false
- * isPositive(3);  // true
- * ```
- *
- * @returns {boolean} True if it's positive, false if otherwise.
- */
-export function isPositive(num) {
-    return num > 0;
-}
-/**
- * Returns the smallest number in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * min([4, 2, 7, 1]); // 1
- * ```
- *
- * @returns {number} The smallest number in the array.
- */
-export function min(arr) {
-    return Math.min(...arr);
-}
-/**
- * Returns the highest number in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * max([4, 2, 7, 1]); // 7
- * ```
- *
- * @returns {number} The highest number in the array.
- */
-export function max(arr) {
-    return Math.max(...arr);
-}
-/**
- * Turns centimeters (CM) to inches (IN).
- *
- * @param {number} cms Centimeters.
- *
- * @example
- * ```ts
- * centimetersToInches(10); // 3.94
- * ```
- *
- * @returns {number} Inches.
- */
-export function centimetersToInches(cms) {
-    return cms / 2.54;
-}
-/**
- * Turns inches (IN) to centimeters (CM).
- *
- * @param {number} ins Inches.
- *
- * @example
- * ```ts
- * inchesToCentimeters(10); // 25.4
- * ```
- *
- * @returns {number} Inches.
- */
-export function inchesToCentimeters(ins) {
-    return ins * 2.54;
-}
-/**
- * Turns Celsius (ºC) to Fahrenheit (ºF). Analog to {@linkcode fahrenheitToCelsius}.
- *
- * @param {number} celsius Celsius.
- *
- * @example
- * ```ts
- * celsiusToFahrenheit(25); // 77
- * ```
- *
- * @returns {number} Fahrenheit.
- */
-export function celsiusToFahrenheit(celsius) {
-    return ((celsius * 1.8) + 32);
-}
-/**
- * Turns Fahrenheit (ºF) to Celsius (ºC). Analog to {@linkcode celsiusToFahrenheit}.
- *
- * @param {number} fahrenheit Celsius.
- *
- * @example
- * ```ts
- * fahrenheitToCelsius(104); // 40
- * ```
- *
- * @returns {number} Celsius.
- */
-export function fahrenheitToCelsius(fahrenheit) {
-    return ((fahrenheit - 32) * (1 / 1.8));
-}
-/**
- * Turns kilometers per hour (KPH or KM/H) to Miles per hour (MPH). Analog to {@linkcode milesPerHourToKilometersPerHour}.
- *
- * @param {number} kph KPH.
- *
- * @example
- * ```ts
- * kilometersPerHourToMilesPerHour(180); // 111.846815
- * ```
- *
- * @returns {number} MPH.
- */
-export function kilometersPerHourToMilesPerHour(kph) {
-    return kph / 1.609344;
-}
-/**
- * Turns Miles per hour (MPH) to Kilometers per hour (KPH or KM/H). Analog to {@linkcode milesPerHourToKilometersPerHour}.
- *
- * @param {number} mph MPH.
- *
- * @example
- * ```ts
- * milesPerHourToKilometersPerHour(180); // 289.68192
- * ```
- *
- * @returns {number} MPH.
- */
-export function milesPerHourToKilometersPerHour(mph) {
-    return mph * 1.609344;
-}
-/**
- * Calculates the number of combinations of `n` items taken `r` at a time.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * combinations(5, 3); // 10
- * ```
- *
- * @returns {number} The number of combinations.
- */
-export function combinations(n, r) {
-    if (r > n || 0 >= n || 0 >= r)
-        return 0;
-    return factorial(n) / (factorial(r) * factorial(n - r));
-}
-/**
- * Calculates the number of permutations of `n` items.
- *
- * @param {number} n Total number of items.
- *
- * @example
- * ```ts
- * permutations(5); // 120
- * ```
- *
- * @returns {number} The number of permutations.
- */
-export function permutations(n) {
-    if (0 >= n)
-        return 0;
-    return factorial(n);
-}
-/**
- * Calculates the number of variations of `n` items taken `r` at a time.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * variations(5, 3); // 60
- * ```
- *
- * @returns {number} The number of variations.
- */
-export function variations(n, r) {
-    if (r > n || 0 >= n || 0 >= r)
-        return 0;
-    return factorial(n) / factorial(n - r);
-}
-/**
- * Calculates the number of variations of `n` items taken `r` at a time, with repetitions.
- *
- * @param {number} n Total number of items.
- * @param {number[]} rs Array of repetitions for each item.
- *
- * @example
- * ```ts
- * variationsR(5, [2, 3]); // 10
- * ```
- *
- * @returns {number} The number of variations with repetitions.
- */
-export function permutationsR(n, rs) {
-    if (sumArray(rs) !== n)
-        return 0;
-    return (factorial(n) / (rs.reduce((acc, curr) => acc * factorial(curr))));
-}
-/**
- * Calculates the number of variations of `n` items taken `r` at a time, with repetitions.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * variationsR(5, 3); // 125
- * ```
- *
- * @returns {number} The number of variations with repetitions.
- */
-export function variationsR(n, r) {
-    if (r > n || 0 >= n || 0 >= r)
-        return 0;
-    return Math.pow(n, r);
-}
-/**
- * Calculates the number of possibilities of a given set of options.
- *
- * @param {number} options Total number of options.
- * @param {number | number[]} possibleCombinations Number of possible combinations.
- * @param {ICombinatorialOptions} settings Settings for the calculation.
- *
- * @example
- * ```ts
- * "Given the numbers 1, 2, and 3, how many combinations of 2 can I make?"
- * possibilities(3, 2, { elementsCanRepeat: false, orderMatters: false }); // 3
- * ```
- *
- * @returns {number} The number of possibilities.
- */
-export function possibilities(options, possibleCombinations, settings) {
-    const { elementsCanRepeat = false, orderMatters = false, allElementsUsed = false } = settings;
-    if (!orderMatters) {
-        if (Array.isArray(possibleCombinations))
-            throw new Error("Impossible to calculate.");
-        return combinations(options, possibleCombinations);
-    }
-    if (!elementsCanRepeat) {
-        if (Array.isArray(possibleCombinations))
-            throw new Error("Impossible to calculate.");
-        if (allElementsUsed)
-            return permutations(options);
-        return variations(options, possibleCombinations);
-    }
-    if (!allElementsUsed) {
-        if (Array.isArray(possibleCombinations))
-            throw new Error("Impossible to calculate.");
-        return variationsR(options, possibleCombinations);
-    }
-    if (!Array.isArray(possibleCombinations))
-        throw new Error("Impossible to calculate.");
-    return permutationsR(options, possibleCombinations);
-}
+function e(e){return e*Math.PI/180}function t(e){return e*180/Math.PI}function n(e){return e*.621371}function r(e){return e/.621371}function i(e){return e*3.28084}function a(e){return e/3.28084}function o(e){return e%2==0}function s(e){return e%2!=0}function c(e,t=0){return Number(e.toFixed(t))}function l(e,t){return Math.floor(Math.random()*(t-e+1))+e}function u(e){if(e<2)return!1;for(let t=2;t<=Math.sqrt(e);t++)if(e%t===0)return!1;return!0}function d(e){if(e<0)throw Error(`Index must be a non-negative integer.`);let t=[],n=0,r=0;for(;t.length<=e;)console.log(t),u(n)&&(t.push(n),r++),n++;return t[e]}function f(e){return e.reduce((e,t)=>e+t,0)}function p(e){return f(e)/e.length}function m(e,t,n){return e>=t&&e<=n}function h(e){return e<=1?1:e*h(e-1)}function g(e){return Number.isInteger(Math.sqrt(e))}function _(e,t){for(;t!==0;){let n=t;t=e%t,e=n}return e}function v(e,t){return e*t/_(e,t)}function y(e,t){return Math.abs(e-t)}function b(e){return e<0}function x(e){return e>0}function S(e){return Math.min(...e)}function C(e){return Math.max(...e)}function w(e){return e/2.54}function T(e){return e*2.54}function E(e){return e*1.8+32}function D(e){return(e-32)*(1/1.8)}function O(e){return e/1.609344}function k(e){return e*1.609344}function A(e,t){return t>e||0>=e||0>=t?0:h(e)/(h(t)*h(e-t))}function j(e){return 0>=e?0:h(e)}function M(e,t){return t>e||0>=e||0>=t?0:h(e)/h(e-t)}function N(e,t){return f(t)===e?h(e)/t.reduce((e,t)=>e*h(t)):0}function P(e,t){return t>e||0>=e||0>=t?0:e**+t}function F(e,t,n){let{elementsCanRepeat:r=!1,orderMatters:i=!1,allElementsUsed:a=!1}=n;if(!i){if(Array.isArray(t))throw Error(`Impossible to calculate.`);return A(e,t)}if(!r){if(Array.isArray(t))throw Error(`Impossible to calculate.`);return a?j(e):M(e,t)}if(!a){if(Array.isArray(t))throw Error(`Impossible to calculate.`);return P(e,t)}if(!Array.isArray(t))throw Error(`Impossible to calculate.`);return N(e,t)}export{y as absDiff,p as average,E as celsiusToFahrenheit,w as centimetersToInches,A as combinations,e as degreesToRadians,h as factorial,D as fahrenheitToCelsius,a as feetToMeters,_ as gcd,T as inchesToCentimeters,m as isBetween,o as isEven,b as isNegative,s as isOdd,g as isPerfectSquare,x as isPositive,u as isPrime,O as kilometersPerHourToMilesPerHour,n as kilometersToMiles,v as lcm,C as max,i as metersToFeet,k as milesPerHourToKilometersPerHour,r as milesToKilometers,S as min,j as permutations,N as permutationsR,F as possibilities,d as primeAt,t as radiansToDegrees,l as random,c as roundTo,f as sumArray,M as variations,P as variationsR};
+//# sourceMappingURL=mod.js.map

package/package.json

@@ -8,19 +8,28 @@
   },
   "description": "A great set of utilities for interacting with numbers. Serving 36 functions.",
   "homepage": "https://github.com/ZakaHaceCosas/dev-utils",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "type": "module",
   "main": "./dist/mod.js",
   "name": "numeric-utils",
   "exports": {
     ".": {
-      "import": "./dist/mod.js",
+      "default": "./dist/mod.js",
       "types": "./dist/mod.d.ts"
     }
   },
-  "files": ["dist/*.js", "dist/*.d.ts"],
+  "files": [
+    "dist/*.js",
+    "dist/*.d.ts"
+  ],
   "types": "./dist/mod.d.ts",
   "license": "MIT",
-  "keywords": ["numbers", "number", "math", "number utils", "math utils"],
+  "keywords": [
+    "numbers",
+    "number",
+    "math",
+    "number utils",
+    "math utils"
+  ],
   "repository": "git+https://github.com/ZakaHaceCosas/dev-utils.git"
 }

package/dist/mod.d.ts

@@ -1,564 +0,0 @@
-/**
- * A great set of utilities for interacting with numbers. Serving 36 functions.
- * @author [ZakaHaceCosas](https://github.com/ZakaHaceCosas/)
- *
- * @example
- * ```ts
- * import { average } from "@zakahacecosas/number-utils";
- *
- * const grades = [5, 7, 4, 9, 5, 6.1];
- * const averageGrade = average(grades); // get the avg
- * return `You scored an average of ${averageGrade}`;
- * ```
- *
- * @example
- * ```ts
- * import { roundTo, min, max } from "@zakahacecosas/number-utils";
- *
- * function analyzeWages(wages: number[]) {
- *   const avgWage = roundTo(average(avgWage), 2);
- *   const highestWage = max(avgWage);
- *   const lowestWage = min(avgWage);
- *
- *   console.log(`Average wage: ${avgWage}€`);
- *   console.log(`Highest wage: ${highestWage}€`);
- *   console.log(`Lowest wage: ${lowestWage}€`);
- * }
- *
- * const wages = [1800, 2200, 2500, 1900, 2750];
- * analyzeWages(wages);
- * ```
- *
- * @module
- */
-/**
- * Options for combinatorial functions, {@linkcode possibilities}, {@linkcode combinations}, {@linkcode permutations}, and {@linkcode variations}.
- *
- * @export
- * @interface ICombinatorialOptions
- */
-export interface ICombinatorialOptions {
-    /** Whether elements are repeatable.
-     *
-     * Set it to true if, given options `1`, `2`, and `3`, `111` is considered a valid combination.
-     */
-    elementsCanRepeat?: boolean;
-    /** Whether the order matters.
-     *
-     * Set it to false if, given options `A` and `B`, `AB` and `BA` are considered the same.
-     *
-     * When set to false, other settings from this interface are ignored.
-     *
-     * @default_value true
-     */
-    orderMatters?: boolean;
-    /** Whether all elements will be used. This is used to determine the calculation method.
-     *
-     * Set it to false if not all elements are used. This is better understood with an example:
-     * ```txt
-     * Out of 10 people, 3 people can be elected to be part of a committee.
-     * ```
-     * In this case, `allElementsUsed` is false, since we are only using 3 out of 10 elements - yet the 10 elements count (as each of the 10 persons can be part of a possible combination).
-     */
-    allElementsUsed?: boolean;
-}
-/**
- * Converts degrees to radians.
- *
- * @param {number} deg Degrees.
- *
- * @example
- * ```ts
- * degreesToRadians(180); // 3.141592653589793
- * ```
- *
- * @returns {number} Radians.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export declare function degreesToRadians(deg: number): number;
-/**
- * Converts radians to degrees.
- *
- * @param {number} rad Radians.
- *
- * @example
- * ```ts
- * radiansToDegrees(Math.PI); // 180
- * ```
- *
- * @returns {number} Degrees.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export declare function radiansToDegrees(rad: number): number;
-/**
-   * Converts kilometers to miles.
-   *
-   * @param {number} km Kilometers.
-   *
-   * @example
-   * ```ts
-   * kilometersToMiles(5); // 3.106855
-   * ```
-      * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
-
-   * @returns {number} Miles.
-   */
-export declare function kilometersToMiles(km: number): number;
-/**
- * Converts miles to kilometers.
- *
- * @param {number} miles Miles.
- *
- * @example
- * ```ts
- * milesToKilometers(5); // 8.046722
- * ```
- *
- * @returns {number} Degrees.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export declare function milesToKilometers(miles: number): number;
-/**
- * Converts meters to feet.
- *
- * @param {number} meters Meters.
- *
- * @example
- * ```ts
- * metersToFeet(5); // 16.4042
- * ```
- *
- * @returns {number} Feet.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export declare function metersToFeet(meters: number): number;
-/**
- * Converts feet to meters.
- *
- * @param {number} feet Feet.
- *
- * @example
- * ```ts
- * feetToMeters(5); // 1.524
- * ```
- *
- * @returns {number} Meters.
- * @available Also served from [geo-utils](https://jsr.io/@zakahacecosas/geo-utils).
- */
-export declare function feetToMeters(feet: number): number;
-/**
- * _A classic._ Checks if a given number is even or not. Analog to {@linkcode isOdd}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isEven(2); // true
- * isEven(3); // false
- * ```
- *
- * @returns {boolean} True if it's even, false if otherwise.
- */
-export declare function isEven(num: number): boolean;
-/**
- * _A classic._ Checks if a given number is odd or not. Analog to {@linkcode isEven}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isOdd(2); // false
- * isOdd(3); // true
- * ```
- *
- * @returns {boolean} True if it's odd, false if otherwise.
- */
-export declare function isOdd(num: number): boolean;
-/**
- * Rounds a given number to a specified decimal precision.
- *
- * @param {number} num Number to round.
- * @param {number} [precision=0] Amount of decimals to include. Defaults to 0.
- *
- * @example
- * ```ts
- * roundTo(3.14159, 2) // 3.14
- * ```
- *
- * @returns {number} The rounded number.
- */
-export declare function roundTo(num: number, precision?: number): number;
-/**
- * Generates a random integer between min and max (inclusive).
- *
- * @param {number} min Minimum number, inclusive.
- * @param {number} max Maximum number, inclusive.
- *
- * @example
- * ```ts
- * random(1, 10)   // returns a random num between 1 and 10, e.g. "7"
- * random(65, 105) // returns a random num between 65 and 105, e.g. "81"
- * ```
- *
- * @returns {number} A random number between `min` and `max`.
- */
-export declare function random(min: number, max: number): number;
-/**
- * Checks if a given number is prime.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isPrime(7) // true
- * isPrime(8) // false
- * ```
- *
- * @returns {boolean} True if the given number is prime, false if otherwise.
- */
-export declare function isPrime(num: number): boolean;
-/**
- * Returns the n-th prime number. **Computationally expensive.**
- *
- * @export
- * @param {number} index Index of the prime number, as in a JS array. Index 0 is number 2, for example.
- *
- * @example
- * ```ts
- * primeAt(0); // 2
- * primeAt(3); // 7
- * primeAt(9999999999); // your PC has likely crashed at this point
- * ```
- *
- * @returns {number} The prime number at the given index.
- */
-export declare function primeAt(index: number): number;
-/**
- * Returns the sum of all numbers in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * sumArray([1, 2, 3]) // 6
- * ```
- *
- * @returns {number} The sum of all numbers in the array.
- */
-export declare function sumArray(arr: number[]): number;
-/**
- * Returns the average of all numbers in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * average([1, 2, 3, 4]) // 2.5
- * ```
- *
- * @returns {number} The average of all numbers in the array.
- */
-export declare function average(arr: number[]): number;
-/**
- * Checks if a given number is between two numbers, both of them inclusive.
- *
- * @param {number} num Number to check.
- * @param {number} min Minimum number. Inclusive.
- * @param {number} max Maximum number. Inclusive.
- *
- * @example
- * ```ts
- * isBetween(5, 1, 10); // true
- * isBetween(15, 1, 10); // false
- * ```
- *
- * @returns {boolean} True if the number is between `min` and `max`, false if otherwise.
- */
-export declare function isBetween(num: number, min: number, max: number): boolean;
-/**
- * Calculates the factorial of a number. For reference, the factorial of `n` (`n!`), is multiplying that number by each number below of it and above zero.
- *
- * @param {number} num Number to calculate the factorial for.
- *
- * @example
- * ```ts
- * factorial(5) // 120, since 5 * 4 * 3 * 2 * 1 = 120
- * ```
- *
- * @returns {number} The factorial of the given number.
- */
-export declare function factorial(num: number): number;
-/**
- * Checks if a number is a perfect square. For reference, a perfect square is a number that, when squared, returns an exact value.
- *
- * @param {number} num Number to check for.
- *
- * @example
- * ```ts
- * isPerfectSquare(16); // true
- * isPerfectSquare(18); // false
- * ```
- *
- * @returns {boolean} True if it's a perfect square, false if otherwise.
- */
-export declare function isPerfectSquare(num: number): boolean;
-/**
- * Finds the greatest common divisor (GCD) of two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * gcd(12, 18); // 6.
- * ```
- *
- * @returns {number} The GCD of both numbers.
- */
-export declare function gcd(a: number, b: number): number;
-/**
- * Finds the least common multiple (LCM) of two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * lcm(12, 18); // 36.
- * ```
- *
- * @returns {number} The LCM of both numbers.
- */
-export declare function lcm(a: number, b: number): number;
-/**
- * Returns the absolute difference between two numbers.
- *
- * @param {number} a First number.
- * @param {number} b Second number.
- *
- * @example
- * ```ts
- * absDiff(10, 3); // 7
- * ```
- *
- * @returns {number} Their absolute difference.
- */
-export declare function absDiff(a: number, b: number): number;
-/**
- * _A classic._ Checks if a given number is negative or not. Analog to {@linkcode isPositive}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isNegative(-2); // true
- * isNegative(3);  // false
- * ```
- *
- * @returns {boolean} True if it's negative, false if otherwise.
- */
-export declare function isNegative(num: number): boolean;
-/**
- * _A classic._ Checks if a given number is positive or not. Analog to {@linkcode isNegative}.
- *
- * @param {number} num Number to check.
- *
- * @example
- * ```ts
- * isPositive(-2); // false
- * isPositive(3);  // true
- * ```
- *
- * @returns {boolean} True if it's positive, false if otherwise.
- */
-export declare function isPositive(num: number): boolean;
-/**
- * Returns the smallest number in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * min([4, 2, 7, 1]); // 1
- * ```
- *
- * @returns {number} The smallest number in the array.
- */
-export declare function min(arr: number[]): number;
-/**
- * Returns the highest number in an array.
- *
- * @param {number[]} arr Array of numbers.
- *
- * @example
- * ```ts
- * max([4, 2, 7, 1]); // 7
- * ```
- *
- * @returns {number} The highest number in the array.
- */
-export declare function max(arr: number[]): number;
-/**
- * Turns centimeters (CM) to inches (IN).
- *
- * @param {number} cms Centimeters.
- *
- * @example
- * ```ts
- * centimetersToInches(10); // 3.94
- * ```
- *
- * @returns {number} Inches.
- */
-export declare function centimetersToInches(cms: number): number;
-/**
- * Turns inches (IN) to centimeters (CM).
- *
- * @param {number} ins Inches.
- *
- * @example
- * ```ts
- * inchesToCentimeters(10); // 25.4
- * ```
- *
- * @returns {number} Inches.
- */
-export declare function inchesToCentimeters(ins: number): number;
-/**
- * Turns Celsius (ºC) to Fahrenheit (ºF). Analog to {@linkcode fahrenheitToCelsius}.
- *
- * @param {number} celsius Celsius.
- *
- * @example
- * ```ts
- * celsiusToFahrenheit(25); // 77
- * ```
- *
- * @returns {number} Fahrenheit.
- */
-export declare function celsiusToFahrenheit(celsius: number): number;
-/**
- * Turns Fahrenheit (ºF) to Celsius (ºC). Analog to {@linkcode celsiusToFahrenheit}.
- *
- * @param {number} fahrenheit Celsius.
- *
- * @example
- * ```ts
- * fahrenheitToCelsius(104); // 40
- * ```
- *
- * @returns {number} Celsius.
- */
-export declare function fahrenheitToCelsius(fahrenheit: number): number;
-/**
- * Turns kilometers per hour (KPH or KM/H) to Miles per hour (MPH). Analog to {@linkcode milesPerHourToKilometersPerHour}.
- *
- * @param {number} kph KPH.
- *
- * @example
- * ```ts
- * kilometersPerHourToMilesPerHour(180); // 111.846815
- * ```
- *
- * @returns {number} MPH.
- */
-export declare function kilometersPerHourToMilesPerHour(kph: number): number;
-/**
- * Turns Miles per hour (MPH) to Kilometers per hour (KPH or KM/H). Analog to {@linkcode milesPerHourToKilometersPerHour}.
- *
- * @param {number} mph MPH.
- *
- * @example
- * ```ts
- * milesPerHourToKilometersPerHour(180); // 289.68192
- * ```
- *
- * @returns {number} MPH.
- */
-export declare function milesPerHourToKilometersPerHour(mph: number): number;
-/**
- * Calculates the number of combinations of `n` items taken `r` at a time.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * combinations(5, 3); // 10
- * ```
- *
- * @returns {number} The number of combinations.
- */
-export declare function combinations(n: number, r: number): number;
-/**
- * Calculates the number of permutations of `n` items.
- *
- * @param {number} n Total number of items.
- *
- * @example
- * ```ts
- * permutations(5); // 120
- * ```
- *
- * @returns {number} The number of permutations.
- */
-export declare function permutations(n: number): number;
-/**
- * Calculates the number of variations of `n` items taken `r` at a time.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * variations(5, 3); // 60
- * ```
- *
- * @returns {number} The number of variations.
- */
-export declare function variations(n: number, r: number): number;
-/**
- * Calculates the number of variations of `n` items taken `r` at a time, with repetitions.
- *
- * @param {number} n Total number of items.
- * @param {number[]} rs Array of repetitions for each item.
- *
- * @example
- * ```ts
- * variationsR(5, [2, 3]); // 10
- * ```
- *
- * @returns {number} The number of variations with repetitions.
- */
-export declare function permutationsR(n: number, rs: number[]): number;
-/**
- * Calculates the number of variations of `n` items taken `r` at a time, with repetitions.
- *
- * @param {number} n Total number of items.
- * @param {number} r Number of items to choose.
- *
- * @example
- * ```ts
- * variationsR(5, 3); // 125
- * ```
- *
- * @returns {number} The number of variations with repetitions.
- */
-export declare function variationsR(n: number, r: number): number;
-/**
- * Calculates the number of possibilities of a given set of options.
- *
- * @param {number} options Total number of options.
- * @param {number | number[]} possibleCombinations Number of possible combinations.
- * @param {ICombinatorialOptions} settings Settings for the calculation.
- *
- * @example
- * ```ts
- * "Given the numbers 1, 2, and 3, how many combinations of 2 can I make?"
- * possibilities(3, 2, { elementsCanRepeat: false, orderMatters: false }); // 3
- * ```
- *
- * @returns {number} The number of possibilities.
- */
-export declare function possibilities(options: number, possibleCombinations: number | number[], settings: ICombinatorialOptions): number;
-//# sourceMappingURL=mod.d.ts.map