@equinor/videx-math 1.1.10 → 1.2.0

package/dist/{src/index.d.ts → index.d.ts}

@@ -3,7 +3,7 @@
  * @param value Value to clamp
  * @param min Minimum value (Default: 0)
  * @param max Maximum value (Default: 1)
- * @return Clamped value
+ * @returns Clamped value
  *
  * @example
  * clamp(8, 3, 7); // Returns: 7
@@ -13,7 +13,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
+ * @returns Returns either 0 or 1
  */
 export declare function step(edge: number, x: number): number;
 /**
@@ -21,7 +21,7 @@ export declare function step(edge: number, x: number): number;
  * @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
+ * @returns Hermite interpolated value
  */
 export declare function smoothstep(edge0: number, edge1: number, x: number): number;
 /**
@@ -29,7 +29,7 @@ export declare function smoothstep(edge0: number, edge1: number, x: number): num
  * @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
+ * @returns The interpolated value
  *
  * @example
  * lerp(2, 4, 0.5); // Returns 3
@@ -40,7 +40,7 @@ export declare function lerp(a: number, b: number, t: number): number;
  * @param a Start value
  * @param b End value
  * @param value Value between start and end
- * @return Percentage of value between start and end
+ * @returns Percentage of value between start and end
  *
  * @example
  * inverseLerp(2, 4, 3); // Returns 0.5
@@ -75,9 +75,9 @@ export declare function radians(deg: number): number;
  */
 export declare function degrees(rad: number): number;
 /**
- * Normalise an angle to be between -π and +π.
+ * Normalise an angle to be between 0 and 2π.
  * @param rad Angle in radians
- * @return Normalised angle
+ * @returns Normalised angle
  */
 export declare function nrad(rad: number): number;
 /**
@@ -128,7 +128,7 @@ export declare function min(...values: number[]): number;
  * @returns Maximum value
  *
  * @example
- * min([2, 1, 3]); // Returns 3
+ * max([2, 1, 3]); // Returns 3
  */
 export declare function max(values: number[]): number;
 /**
@@ -137,7 +137,7 @@ export declare function max(values: number[]): number;
  * @returns Maximum value
  *
  * @example
- * min(2, 1, 3); // Returns 3
+ * max(2, 1, 3); // Returns 3
  */
 export declare function max(...values: number[]): number;
 /**
@@ -146,7 +146,7 @@ export declare function max(...values: number[]): number;
  * @returns Extent on format [min, max]
  *
  * @example
- * min([2, 1, 3]); // Returns [1, 3]
+ * extent([2, 1, 3]); // Returns [1, 3]
  */
 export declare function extent(values: number[]): [number, number];
 /**
@@ -155,7 +155,7 @@ export declare function extent(values: number[]): [number, number];
  * @returns Extent on format [min, max]
  *
  * @example
- * min(2, 1, 3); // Returns [1, 3]
+ * extent(2, 1, 3); // Returns [1, 3]
  */
 export declare function extent(...values: number[]): [number, number];
 /**

package/dist/index.esm.js

@@ -1 +1 @@
-const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}function step(edge,x){return x>=edge?1:0}function smoothstep(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)}function lerp(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m}function inverseLerp(a,b,value){return clamp((value-a)/(b-a),0,1)}function round(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f}function radians(deg){return deg*DEG2RAD}function degrees(rad){return rad*RAD2DEG}function nrad(rad){const v=rad%TAU;return v<0?v+TAU:v}function seq(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target}function seqI(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target}function min(a,...b){let min;if(Array.isArray(a)){min=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i])}else{min=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i])}return min}function max(a,...b){let max;if(Array.isArray(a)){max=a[0];for(let i=1;i<a.length;i++)a[i]>max&&(max=a[i])}else{max=a;for(let i=0;i<b.length;i++)b[i]>max&&(max=b[i])}return max}function extent(a,...b){let min,max;if(Array.isArray(a)){min=max=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i]),a[i]>max&&(max=a[i])}else{min=max=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i]),b[i]>max&&(max=b[i])}return[min,max]}function mean(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)}export{clamp,degrees,extent,inverseLerp,lerp,max,mean,min,nrad,radians,round,seq,seqI,smoothstep,step};
+const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}function step(edge,x){return x>=edge?1:0}function smoothstep(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)}function lerp(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m}function inverseLerp(a,b,value){return clamp((value-a)/(b-a),0,1)}function round(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f}function radians(deg){return deg*DEG2RAD}function degrees(rad){return rad*RAD2DEG}function nrad(rad){const v=rad%TAU;return v<0?v+TAU:v}function seq(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target}function seqI(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target}function min(a,...b){let minimum;if(Array.isArray(a)){minimum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i])}else{minimum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i])}return minimum}function max(a,...b){let maximum;if(Array.isArray(a)){maximum=a[0];for(let i=1;i<a.length;i++)a[i]>maximum&&(maximum=a[i])}else{maximum=a;for(let i=0;i<b.length;i++)b[i]>maximum&&(maximum=b[i])}return maximum}function extent(a,...b){let minimum,maximum;if(Array.isArray(a)){minimum=maximum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i]),a[i]>maximum&&(maximum=a[i])}else{minimum=maximum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i]),b[i]>maximum&&(maximum=b[i])}return[minimum,maximum]}function mean(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)}export{clamp,degrees,extent,inverseLerp,lerp,max,mean,min,nrad,radians,round,seq,seqI,smoothstep,step};

package/dist/index.js

@@ -1 +1 @@
-"use strict";const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}exports.clamp=clamp,exports.degrees=function(rad){return rad*RAD2DEG},exports.extent=function(a,...b){let min,max;if(Array.isArray(a)){min=max=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i]),a[i]>max&&(max=a[i])}else{min=max=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i]),b[i]>max&&(max=b[i])}return[min,max]},exports.inverseLerp=function(a,b,value){return clamp((value-a)/(b-a),0,1)},exports.lerp=function(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m},exports.max=function(a,...b){let max;if(Array.isArray(a)){max=a[0];for(let i=1;i<a.length;i++)a[i]>max&&(max=a[i])}else{max=a;for(let i=0;i<b.length;i++)b[i]>max&&(max=b[i])}return max},exports.mean=function(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)},exports.min=function(a,...b){let min;if(Array.isArray(a)){min=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i])}else{min=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i])}return min},exports.nrad=function(rad){const v=rad%TAU;return v<0?v+TAU:v},exports.radians=function(deg){return deg*DEG2RAD},exports.round=function(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f},exports.seq=function(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target},exports.seqI=function(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target},exports.smoothstep=function(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)},exports.step=function(edge,x){return x>=edge?1:0};
+"use strict";const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}exports.clamp=clamp,exports.degrees=function(rad){return rad*RAD2DEG},exports.extent=function(a,...b){let minimum,maximum;if(Array.isArray(a)){minimum=maximum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i]),a[i]>maximum&&(maximum=a[i])}else{minimum=maximum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i]),b[i]>maximum&&(maximum=b[i])}return[minimum,maximum]},exports.inverseLerp=function(a,b,value){return clamp((value-a)/(b-a),0,1)},exports.lerp=function(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m},exports.max=function(a,...b){let maximum;if(Array.isArray(a)){maximum=a[0];for(let i=1;i<a.length;i++)a[i]>maximum&&(maximum=a[i])}else{maximum=a;for(let i=0;i<b.length;i++)b[i]>maximum&&(maximum=b[i])}return maximum},exports.mean=function(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)},exports.min=function(a,...b){let minimum;if(Array.isArray(a)){minimum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i])}else{minimum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i])}return minimum},exports.nrad=function(rad){const v=rad%TAU;return v<0?v+TAU:v},exports.radians=function(deg){return deg*DEG2RAD},exports.round=function(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f},exports.seq=function(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target},exports.seqI=function(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target},exports.smoothstep=function(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)},exports.step=function(edge,x){return x>=edge?1:0};

package/dist/index.umd.js

@@ -1 +1 @@
-!function(global,factory){"object"==typeof exports&&"undefined"!=typeof module?factory(exports):"function"==typeof define&&define.amd?define(["exports"],factory):factory((global="undefined"!=typeof globalThis?globalThis:global||self)["videx-math"]={})}(this,(function(exports){"use strict";const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}exports.clamp=clamp,exports.degrees=function(rad){return rad*RAD2DEG},exports.extent=function(a,...b){let min,max;if(Array.isArray(a)){min=max=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i]),a[i]>max&&(max=a[i])}else{min=max=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i]),b[i]>max&&(max=b[i])}return[min,max]},exports.inverseLerp=function(a,b,value){return clamp((value-a)/(b-a),0,1)},exports.lerp=function(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m},exports.max=function(a,...b){let max;if(Array.isArray(a)){max=a[0];for(let i=1;i<a.length;i++)a[i]>max&&(max=a[i])}else{max=a;for(let i=0;i<b.length;i++)b[i]>max&&(max=b[i])}return max},exports.mean=function(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)},exports.min=function(a,...b){let min;if(Array.isArray(a)){min=a[0];for(let i=1;i<a.length;i++)a[i]<min&&(min=a[i])}else{min=a;for(let i=0;i<b.length;i++)b[i]<min&&(min=b[i])}return min},exports.nrad=function(rad){const v=rad%TAU;return v<0?v+TAU:v},exports.radians=function(deg){return deg*DEG2RAD},exports.round=function(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f},exports.seq=function(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target},exports.seqI=function(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target},exports.smoothstep=function(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)},exports.step=function(edge,x){return x>=edge?1:0}}));
+!function(global,factory){"object"==typeof exports&&"undefined"!=typeof module?factory(exports):"function"==typeof define&&define.amd?define(["exports"],factory):factory((global="undefined"!=typeof globalThis?globalThis:global||self)["videx-math"]={})}(this,(function(exports){"use strict";const RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min=0,max=1){return value<min?min:value>max?max:value}exports.clamp=clamp,exports.degrees=function(rad){return rad*RAD2DEG},exports.extent=function(a,...b){let minimum,maximum;if(Array.isArray(a)){minimum=maximum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i]),a[i]>maximum&&(maximum=a[i])}else{minimum=maximum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i]),b[i]>maximum&&(maximum=b[i])}return[minimum,maximum]},exports.inverseLerp=function(a,b,value){return clamp((value-a)/(b-a),0,1)},exports.lerp=function(a,b,t){const m=clamp(t,0,1);return a*(1-m)+b*m},exports.max=function(a,...b){let maximum;if(Array.isArray(a)){maximum=a[0];for(let i=1;i<a.length;i++)a[i]>maximum&&(maximum=a[i])}else{maximum=a;for(let i=0;i<b.length;i++)b[i]>maximum&&(maximum=b[i])}return maximum},exports.mean=function(a,...b){let sum=0;if(Array.isArray(a)){for(let i=0;i<a.length;i++)sum+=a[i];return sum/a.length}for(let i=0;i<b.length;i++)sum+=b[i];return(sum+a)/(b.length+1)},exports.min=function(a,...b){let minimum;if(Array.isArray(a)){minimum=a[0];for(let i=1;i<a.length;i++)a[i]<minimum&&(minimum=a[i])}else{minimum=a;for(let i=0;i<b.length;i++)b[i]<minimum&&(minimum=b[i])}return minimum},exports.nrad=function(rad){const v=rad%TAU;return v<0?v+TAU:v},exports.radians=function(deg){return deg*DEG2RAD},exports.round=function(value,digits=1){const f=Math.pow(10,digits);return Math.round(value*f)/f},exports.seq=function(start,end,steps){const target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(let i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target},exports.seqI=function(steps){const target=new Array(steps),incr=1/(steps-1);target[0]=0;for(let i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target},exports.smoothstep=function(edge0,edge1,x){const t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)},exports.step=function(edge,x){return x>=edge?1:0}}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/videx-math",
-  "version": "1.1.10",
+  "version": "1.2.0",
   "description": "A library with math used by Videx.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -19,16 +19,18 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "prebuild": "rimraf dist",
+    "prebuild": "node scripts/remove.mjs dist",
     "build": "rollup -c",
     "prepub": "npm run build",
     "pub": "npm publish --access=public",
     "test": "vitest run",
     "test:watch": "vitest",
-    "lint": "eslint src --color",
-    "predocs": "rimraf docs",
+    "coverage": "vitest run --coverage",
+    "coverage:ci": "vitest run --coverage",
+    "lint": "oxlint",
+    "predocs": "node scripts/remove.mjs docs",
     "docs": "typedoc --out docs src",
-    "postdocs": "node postdocs.copyfiles.mjs",
+    "postdocs": "node scripts/copy_docs_assets.mjs",
     "prettier": "prettier . --write"
   },
   "repository": {
@@ -45,19 +47,15 @@
   },
   "homepage": "https://github.com/equinor/videx-math#readme",
   "devDependencies": {
-    "@eslint/js": "^9.39.4",
-    "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^1.0.0",
     "@rollup/plugin-typescript": "^12.3.0",
-    "eslint": "^9.39.4",
-    "eslint-plugin-import": "^2.32.0",
+    "@vitest/coverage-v8": "4.1.10",
+    "oxlint": "^1.82.0",
     "prettier": "^3.9.6",
-    "rimraf": "^6.1.3",
     "rollup": "^4.60.0",
     "tslib": "^2.8.1",
     "typedoc": "^0.28.18",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.57.2",
     "vitest": "^4.1.10"
   }
 }

package/dist/test/index.test.d.ts

@@ -1 +0,0 @@
-export {};