@equinor/videx-math 1.0.12 → 1.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Equinor
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Equinor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -22,25 +22,4 @@ const lerp = someVar.lerp;
 ```
 Where X.X.X is desired version number.
 
-## Available functions
-
-<table style="width:auto;">
-  <tr>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#clamp">clamp</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#degrees">degrees</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#lerp">lerp</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#nrad">nrad</a></td>
-  </tr>
-  <tr>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#radians">radians</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#round">round</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#seq">seq</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#seqI">seqI</a></td>
-  </tr>
-  <tr>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#smoothstep">smoothstep</a></td>
-    <td><a href="https://equinor.github.io/videx-math/modules/_index_.html#step">step</a></td>
-  </tr>
-</table>
-
 ![Equinor Logo](images/equinor-logo.png)

package/dist/index.d.ts

@@ -35,6 +35,17 @@ export declare function smoothstep(edge0: number, edge1: number, x: number): num
  * 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
@@ -93,3 +104,75 @@ export declare function seq(start: number, end: number, steps: number): number[]
  * 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/dist/index.esm.js

@@ -1 +1 @@
-var RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min,max){return void 0===min&&(min=0),void 0===max&&(max=1),value<min?min:value>max?max:value}function step(edge,x){return x>=edge?1:0}function smoothstep(edge0,edge1,x){var t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)}function lerp(a,b,t){var m=clamp(t,0,1);return a*(1-m)+b*m}function round(value,digits){void 0===digits&&(digits=1);var 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){var v=rad%TAU;return v<0?v+TAU:v}function seq(start,end,steps){var target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(var i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target}function seqI(steps){var target=new Array(steps),incr=1/(steps-1);target[0]=0;for(var i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target}export{clamp,degrees,lerp,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 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};

package/dist/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min,max){return void 0===min&&(min=0),void 0===max&&(max=1),value<min?min:value>max?max:value}function step(edge,x){return x>=edge?1:0}function smoothstep(edge0,edge1,x){var t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)}function lerp(a,b,t){var m=clamp(t,0,1);return a*(1-m)+b*m}function round(value,digits){void 0===digits&&(digits=1);var 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){var v=rad%TAU;return v<0?v+TAU:v}function seq(start,end,steps){var target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(var i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target}function seqI(steps){var target=new Array(steps),incr=1/(steps-1);target[0]=0;for(var i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target}exports.clamp=clamp,exports.degrees=degrees,exports.lerp=lerp,exports.nrad=nrad,exports.radians=radians,exports.round=round,exports.seq=seq,exports.seqI=seqI,exports.smoothstep=smoothstep,exports.step=step;
+"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};

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=global||self).Vector2={})}(this,(function(exports){"use strict";var RAD2DEG=180/Math.PI,DEG2RAD=Math.PI/180,TAU=2*Math.PI;function clamp(value,min,max){return void 0===min&&(min=0),void 0===max&&(max=1),value<min?min:value>max?max:value}exports.clamp=clamp,exports.degrees=function(rad){return rad*RAD2DEG},exports.lerp=function(a,b,t){var m=clamp(t,0,1);return a*(1-m)+b*m},exports.nrad=function(rad){var v=rad%TAU;return v<0?v+TAU:v},exports.radians=function(deg){return deg*DEG2RAD},exports.round=function(value,digits){void 0===digits&&(digits=1);var f=Math.pow(10,digits);return Math.round(value*f)/f},exports.seq=function(start,end,steps){var target=new Array(steps),incr=(end-start)/(steps-1);target[0]=start;for(var i=1;i<steps-1;i++)target[i]=start+i*incr;return target[steps-1]=end,target},exports.seqI=function(steps){var target=new Array(steps),incr=1/(steps-1);target[0]=0;for(var i=1;i<steps-1;i++)target[i]=i*incr;return target[steps-1]=1,target},exports.smoothstep=function(edge0,edge1,x){var t=clamp((x-edge0)/(edge1-edge0));return t*t*(3-2*t)},exports.step=function(edge,x){return x>=edge?1:0},Object.defineProperty(exports,"__esModule",{value:!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 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}}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/videx-math",
-  "version": "1.0.12",
+  "version": "1.1.1",
   "description": "A library with math used by Videx.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -16,9 +16,10 @@
     "pub": "npm publish --access=public",
     "test": "jest",
     "test:watch": "jest --watchAll",
+    "lint": "eslint --ext .js,.jsx,.ts,.tsx src --color",
     "predocs": "rimraf docs",
     "docs": "typedoc --out docs src",
-    "postdocs": "copyfiles images/* docs && copyfiles .nojekyll docs"
+    "postdocs": "node postdocs.copyfiles.mjs"
   },
   "repository": {
     "type": "git",
@@ -34,20 +35,21 @@
   },
   "homepage": "https://github.com/equinor/videx-math#readme",
   "devDependencies": {
-    "@types/jest": "^24.0.21",
-    "copyfiles": "^2.1.1",
-    "eslint": "^6.6.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-plugin-import": "^2.18.2",
-    "jest": "^24.9.0",
-    "rimraf": "^3.0.0",
-    "rollup": "^1.26.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-terser": "^5.1.2",
-    "rollup-plugin-typescript2": "^0.24.3",
-    "ts-jest": "^24.1.0",
-    "typedoc": "^0.15.0",
-    "typescript": "^3.6.4"
+    "@types/jest": "^29.5.12",
+    "@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",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.1.0",
+    "tslib": "^2.7.0",
+    "typedoc": "^0.24.8",
+    "typescript": "^4.7.4"
   },
   "jest": {
     "transform": {