@equinor/videx-math 1.1.1 → 1.1.3

package/README.md

@@ -1,3 +1,5 @@
+[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/videx-math/badge)](https://scm-compliance-api.radix.equinor.com/repos/equinor/videx-math/badge)
+
 # Videx math
 
 A library with math functions used by Videx.

package/dist/const.d.ts

@@ -1,15 +1,15 @@
-/**
- * Constant for converting radians to degrees.
- * @private
- */
-export declare const RAD2DEG: number;
-/**
- * Constant for converting degrees to radians.
- * @private
- */
-export declare const DEG2RAD: number;
-/**
- * Constant for 2π.
- * @private
- */
-export declare const TAU: number;
+/**
+ * Constant for converting radians to degrees.
+ * @private
+ */
+export declare const RAD2DEG: number;
+/**
+ * Constant for converting degrees to radians.
+ * @private
+ */
+export declare const DEG2RAD: number;
+/**
+ * Constant for 2π.
+ * @private
+ */
+export declare const TAU: number;

package/dist/index.d.ts

@@ -1,178 +1,178 @@
-/**
- * Clamps the value to min or max if value is less than min or greater than max.
- * @param value Value to clamp
- * @param min Minimum value (Default: 0)
- * @param max Maximum value (Default: 1)
- * @return Clamped value
- *
- * @example
- * clamp(8, 3, 7); // Returns: 7
- */
-export declare function clamp(value: number, min?: number, max?: number): number;
-/**
- * Generate a step function by comparing two values.
- * @param edge Edge of the step function
- * @param x Value used to generate the step function
- * @return Returns either 0 or 1
- */
-export declare function step(edge: number, x: number): number;
-/**
- * Perform Hermite interpolation between two values.
- * @param edge0 Lower edge of the Hermite function
- * @param edge1 Upper edge of the Hermite function
- * @param x Source value for interpolation
- * @return Hermite interpolated value
- */
-export declare function smoothstep(edge0: number, edge1: number, x: number): number;
-/**
- * Linear interpolation between two numbers.
- * @param a Number to interpolate from
- * @param b Number to interpolate to
- * @param t Interpolation parameter, 0 = a and 1 = b
- * @return The interpolated value
- *
- * @example
- * lerp(2, 4, 0.5); // Returns 3
- */
-export declare function lerp(a: number, b: number, t: number): number;
-/**
- * Get the interpolant [t] that produces given value within the range [a, b].
- * @param a Start value
- * @param b End value
- * @param value Value between start and end
- * @return Percentage of value between start and end
- *
- * @example
- * inverseLerp(2, 4, 3); // Returns 0.5
- */
-export declare function inverseLerp(a: number, b: number, value: number): number;
-/**
- * Rounds number to a specific amount of digits.
- * @param value Value to round
- * @param digits Number of digits (Default: 1)
- * @return Rounded value
- *
- * @example
- * round(Math.PI, 3); // Returns 3.142
- */
-export declare function round(value: number, digits?: number): number;
-/**
- * Convert degrees to radians.
- * @param deg Angle in degrees
- * @returns Angle in radians
- *
- * @example
- * radians(90); // Returns π / 2
- */
-export declare function radians(deg: number): number;
-/**
- * Convert radians to degrees.
- * @param rad Angle in radians
- * @returns Angle in degrees
- *
- * @example
- * degrees(Math.PI); // Returns 180
- */
-export declare function degrees(rad: number): number;
-/**
- * Normalise an angle to be between -π and +π.
- * @param rad Angle in radians
- * @return Normalised angle
- */
-export declare function nrad(rad: number): number;
-/**
- * Generates a list of interpolated values between start and end,
- * where the number of elements returned is equal to the amount
- * of steps.
- * @param start Start of interpolated range
- * @param end End of interpolated range
- * @param steps Steps of interpolation
- * @returns Interpolated series
- *
- * @example
- * seq(2, 4, 5); // Returns [2, 2.5, 3, 3.5, 4]
- */
-export declare function seq(start: number, end: number, steps: number): number[];
-/**
- * Generates a list of interpolated values between 0 and 1,
- * where the number of elements returned is equal to the amount
- * of steps.
- * @param steps Steps of interpolation
- * @returns Interpolated series
- *
- * @example
- * seqI(3); // Returns [0, 0.5, 1]
- */
-export declare function seqI(steps: number): number[];
-/**
- * Retrieves the minimum value of an array.
- * @param values Array with values
- * @returns Minimum value
- *
- * @example
- * min([2, 1, 3]); // Returns 1
- */
-export declare function min(values: number[]): number;
-/**
- * Retrieves the minimum value among a collection of values.
- * @param values Collection of values
- * @returns Minimum value
- *
- * @example
- * min(2, 1, 3); // Returns 1
- */
-export declare function min(...values: number[]): number;
-/**
- * Retrieves the maximum value of an array.
- * @param values Array with values
- * @returns Maximum value
- *
- * @example
- * min([2, 1, 3]); // Returns 3
- */
-export declare function max(values: number[]): number;
-/**
- * Retrieves the maximum value among a collection of values.
- * @param values Collection of values
- * @returns Maximum value
- *
- * @example
- * min(2, 1, 3); // Returns 3
- */
-export declare function max(...values: number[]): number;
-/**
- * Retrieves the extent of an array.
- * @param values Array with values
- * @returns Extent on format [min, max]
- *
- * @example
- * min([2, 1, 3]); // Returns [1, 3]
- */
-export declare function extent(values: number[]): [number, number];
-/**
- * Retrieves the extent of a collection of values.
- * @param values Collection of values
- * @returns Extent on format [min, max]
- *
- * @example
- * min(2, 1, 3); // Returns [1, 3]
- */
-export declare function extent(...values: number[]): [number, number];
-/**
- * Find the mean of a numeric array.
- * @param values Array with values
- * @returns Mean of values
- *
- * @example
- * mean([2, 1, 3]); // Returns 2
- */
-export declare function mean(values: number[]): number;
-/**
- * Find the mean of a collection of values.
- * @param values Collection of values
- * @returns Mean of values
- *
- * @example
- * mean(2, 1, 3); // Returns 2
- */
-export declare function mean(...values: number[]): number;
+/**
+ * Clamps the value to min or max if value is less than min or greater than max.
+ * @param value Value to clamp
+ * @param min Minimum value (Default: 0)
+ * @param max Maximum value (Default: 1)
+ * @return Clamped value
+ *
+ * @example
+ * clamp(8, 3, 7); // Returns: 7
+ */
+export declare function clamp(value: number, min?: number, max?: number): number;
+/**
+ * Generate a step function by comparing two values.
+ * @param edge Edge of the step function
+ * @param x Value used to generate the step function
+ * @return Returns either 0 or 1
+ */
+export declare function step(edge: number, x: number): number;
+/**
+ * Perform Hermite interpolation between two values.
+ * @param edge0 Lower edge of the Hermite function
+ * @param edge1 Upper edge of the Hermite function
+ * @param x Source value for interpolation
+ * @return Hermite interpolated value
+ */
+export declare function smoothstep(edge0: number, edge1: number, x: number): number;
+/**
+ * Linear interpolation between two numbers.
+ * @param a Number to interpolate from
+ * @param b Number to interpolate to
+ * @param t Interpolation parameter, 0 = a and 1 = b
+ * @return The interpolated value
+ *
+ * @example
+ * lerp(2, 4, 0.5); // Returns 3
+ */
+export declare function lerp(a: number, b: number, t: number): number;
+/**
+ * Get the interpolant [t] that produces given value within the range [a, b].
+ * @param a Start value
+ * @param b End value
+ * @param value Value between start and end
+ * @return Percentage of value between start and end
+ *
+ * @example
+ * inverseLerp(2, 4, 3); // Returns 0.5
+ */
+export declare function inverseLerp(a: number, b: number, value: number): number;
+/**
+ * Rounds number to a specific amount of digits.
+ * @param value Value to round
+ * @param digits Number of digits (Default: 1)
+ * @return Rounded value
+ *
+ * @example
+ * round(Math.PI, 3); // Returns 3.142
+ */
+export declare function round(value: number, digits?: number): number;
+/**
+ * Convert degrees to radians.
+ * @param deg Angle in degrees
+ * @returns Angle in radians
+ *
+ * @example
+ * radians(90); // Returns π / 2
+ */
+export declare function radians(deg: number): number;
+/**
+ * Convert radians to degrees.
+ * @param rad Angle in radians
+ * @returns Angle in degrees
+ *
+ * @example
+ * degrees(Math.PI); // Returns 180
+ */
+export declare function degrees(rad: number): number;
+/**
+ * Normalise an angle to be between -π and +π.
+ * @param rad Angle in radians
+ * @return Normalised angle
+ */
+export declare function nrad(rad: number): number;
+/**
+ * Generates a list of interpolated values between start and end,
+ * where the number of elements returned is equal to the amount
+ * of steps.
+ * @param start Start of interpolated range
+ * @param end End of interpolated range
+ * @param steps Steps of interpolation
+ * @returns Interpolated series
+ *
+ * @example
+ * seq(2, 4, 5); // Returns [2, 2.5, 3, 3.5, 4]
+ */
+export declare function seq(start: number, end: number, steps: number): number[];
+/**
+ * Generates a list of interpolated values between 0 and 1,
+ * where the number of elements returned is equal to the amount
+ * of steps.
+ * @param steps Steps of interpolation
+ * @returns Interpolated series
+ *
+ * @example
+ * seqI(3); // Returns [0, 0.5, 1]
+ */
+export declare function seqI(steps: number): number[];
+/**
+ * Retrieves the minimum value of an array.
+ * @param values Array with values
+ * @returns Minimum value
+ *
+ * @example
+ * min([2, 1, 3]); // Returns 1
+ */
+export declare function min(values: number[]): number;
+/**
+ * Retrieves the minimum value among a collection of values.
+ * @param values Collection of values
+ * @returns Minimum value
+ *
+ * @example
+ * min(2, 1, 3); // Returns 1
+ */
+export declare function min(...values: number[]): number;
+/**
+ * Retrieves the maximum value of an array.
+ * @param values Array with values
+ * @returns Maximum value
+ *
+ * @example
+ * min([2, 1, 3]); // Returns 3
+ */
+export declare function max(values: number[]): number;
+/**
+ * Retrieves the maximum value among a collection of values.
+ * @param values Collection of values
+ * @returns Maximum value
+ *
+ * @example
+ * min(2, 1, 3); // Returns 3
+ */
+export declare function max(...values: number[]): number;
+/**
+ * Retrieves the extent of an array.
+ * @param values Array with values
+ * @returns Extent on format [min, max]
+ *
+ * @example
+ * min([2, 1, 3]); // Returns [1, 3]
+ */
+export declare function extent(values: number[]): [number, number];
+/**
+ * Retrieves the extent of a collection of values.
+ * @param values Collection of values
+ * @returns Extent on format [min, max]
+ *
+ * @example
+ * min(2, 1, 3); // Returns [1, 3]
+ */
+export declare function extent(...values: number[]): [number, number];
+/**
+ * Find the mean of a numeric array.
+ * @param values Array with values
+ * @returns Mean of values
+ *
+ * @example
+ * mean([2, 1, 3]); // Returns 2
+ */
+export declare function mean(values: number[]): number;
+/**
+ * Find the mean of a collection of values.
+ * @param values Collection of values
+ * @returns Mean of values
+ *
+ * @example
+ * mean(2, 1, 3); // Returns 2
+ */
+export declare function mean(...values: number[]): number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/videx-math",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "A library with math used by Videx.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -16,7 +16,7 @@
     "pub": "npm publish --access=public",
     "test": "jest",
     "test:watch": "jest --watchAll",
-    "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
+    "lint": "eslint src --color",
     "predocs": "rimraf docs",
     "docs": "typedoc --out docs src",
     "postdocs": "node postdocs.copyfiles.mjs"
@@ -35,21 +35,21 @@
   },
   "homepage": "https://github.com/equinor/videx-math#readme",
   "devDependencies": {
-    "@types/jest": "^29.5.12",
+    "@eslint/js": "^9.32.0",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
-    "rollup": "^3.29.4",
-    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.30.0",
-    "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@typescript-eslint/parser": "^8.4.0",
-    "jest": "^29.5.0",
+    "@types/jest": "^29.5.12",
+    "eslint": "^9.32.0",
+    "eslint-plugin-import": "^2.31.0",
+    "jest": "^29.7.0",
     "rimraf": "^6.0.1",
+    "rollup": "^3.29.5",
     "ts-jest": "^29.1.0",
     "tslib": "^2.7.0",
-    "typedoc": "^0.24.8",
-    "typescript": "^4.7.4"
+    "typedoc": "^0.26.6",
+    "typescript": "^4.9.5",
+    "typescript-eslint": "^8.26.1"
   },
   "jest": {
     "transform": {