@equinor/videx-math 1.1.12 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +11 -11
- package/package.json +7 -3
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* @param value Value to clamp
|
|
4
4
|
* @param min Minimum value (Default: 0)
|
|
5
5
|
* @param max Maximum value (Default: 1)
|
|
6
|
-
* @
|
|
6
|
+
* @returns Clamped value
|
|
7
7
|
*
|
|
8
8
|
* @example
|
|
9
9
|
* clamp(8, 3, 7); // Returns: 7
|
|
@@ -13,7 +13,7 @@ export declare function clamp(value: number, min?: number, max?: number): number
|
|
|
13
13
|
* Generate a step function by comparing two values.
|
|
14
14
|
* @param edge Edge of the step function
|
|
15
15
|
* @param x Value used to generate the step function
|
|
16
|
-
* @
|
|
16
|
+
* @returns Returns either 0 or 1
|
|
17
17
|
*/
|
|
18
18
|
export declare function step(edge: number, x: number): number;
|
|
19
19
|
/**
|
|
@@ -21,7 +21,7 @@ export declare function step(edge: number, x: number): number;
|
|
|
21
21
|
* @param edge0 Lower edge of the Hermite function
|
|
22
22
|
* @param edge1 Upper edge of the Hermite function
|
|
23
23
|
* @param x Source value for interpolation
|
|
24
|
-
* @
|
|
24
|
+
* @returns Hermite interpolated value
|
|
25
25
|
*/
|
|
26
26
|
export declare function smoothstep(edge0: number, edge1: number, x: number): number;
|
|
27
27
|
/**
|
|
@@ -29,7 +29,7 @@ export declare function smoothstep(edge0: number, edge1: number, x: number): num
|
|
|
29
29
|
* @param a Number to interpolate from
|
|
30
30
|
* @param b Number to interpolate to
|
|
31
31
|
* @param t Interpolation parameter, 0 = a and 1 = b
|
|
32
|
-
* @
|
|
32
|
+
* @returns The interpolated value
|
|
33
33
|
*
|
|
34
34
|
* @example
|
|
35
35
|
* lerp(2, 4, 0.5); // Returns 3
|
|
@@ -40,7 +40,7 @@ export declare function lerp(a: number, b: number, t: number): number;
|
|
|
40
40
|
* @param a Start value
|
|
41
41
|
* @param b End value
|
|
42
42
|
* @param value Value between start and end
|
|
43
|
-
* @
|
|
43
|
+
* @returns Percentage of value between start and end
|
|
44
44
|
*
|
|
45
45
|
* @example
|
|
46
46
|
* inverseLerp(2, 4, 3); // Returns 0.5
|
|
@@ -75,9 +75,9 @@ export declare function radians(deg: number): number;
|
|
|
75
75
|
*/
|
|
76
76
|
export declare function degrees(rad: number): number;
|
|
77
77
|
/**
|
|
78
|
-
* Normalise an angle to be between
|
|
78
|
+
* Normalise an angle to be between 0 and 2π.
|
|
79
79
|
* @param rad Angle in radians
|
|
80
|
-
* @
|
|
80
|
+
* @returns Normalised angle
|
|
81
81
|
*/
|
|
82
82
|
export declare function nrad(rad: number): number;
|
|
83
83
|
/**
|
|
@@ -128,7 +128,7 @@ export declare function min(...values: number[]): number;
|
|
|
128
128
|
* @returns Maximum value
|
|
129
129
|
*
|
|
130
130
|
* @example
|
|
131
|
-
*
|
|
131
|
+
* max([2, 1, 3]); // Returns 3
|
|
132
132
|
*/
|
|
133
133
|
export declare function max(values: number[]): number;
|
|
134
134
|
/**
|
|
@@ -137,7 +137,7 @@ export declare function max(values: number[]): number;
|
|
|
137
137
|
* @returns Maximum value
|
|
138
138
|
*
|
|
139
139
|
* @example
|
|
140
|
-
*
|
|
140
|
+
* max(2, 1, 3); // Returns 3
|
|
141
141
|
*/
|
|
142
142
|
export declare function max(...values: number[]): number;
|
|
143
143
|
/**
|
|
@@ -146,7 +146,7 @@ export declare function max(...values: number[]): number;
|
|
|
146
146
|
* @returns Extent on format [min, max]
|
|
147
147
|
*
|
|
148
148
|
* @example
|
|
149
|
-
*
|
|
149
|
+
* extent([2, 1, 3]); // Returns [1, 3]
|
|
150
150
|
*/
|
|
151
151
|
export declare function extent(values: number[]): [number, number];
|
|
152
152
|
/**
|
|
@@ -155,7 +155,7 @@ export declare function extent(values: number[]): [number, number];
|
|
|
155
155
|
* @returns Extent on format [min, max]
|
|
156
156
|
*
|
|
157
157
|
* @example
|
|
158
|
-
*
|
|
158
|
+
* extent(2, 1, 3); // Returns [1, 3]
|
|
159
159
|
*/
|
|
160
160
|
export declare function extent(...values: number[]): [number, number];
|
|
161
161
|
/**
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@equinor/videx-math",
|
|
3
|
-
"version": "1.1
|
|
3
|
+
"version": "1.2.1",
|
|
4
4
|
"description": "A library with math used by Videx.",
|
|
5
|
+
"type": "module",
|
|
5
6
|
"main": "dist/index.js",
|
|
6
7
|
"module": "dist/index.esm.js",
|
|
7
8
|
"browser": "dist/index.umd.js",
|
|
@@ -25,6 +26,8 @@
|
|
|
25
26
|
"pub": "npm publish --access=public",
|
|
26
27
|
"test": "vitest run",
|
|
27
28
|
"test:watch": "vitest",
|
|
29
|
+
"coverage": "vitest run --coverage",
|
|
30
|
+
"coverage:ci": "vitest run --coverage",
|
|
28
31
|
"lint": "oxlint",
|
|
29
32
|
"predocs": "node scripts/remove.mjs docs",
|
|
30
33
|
"docs": "typedoc --out docs src",
|
|
@@ -47,12 +50,13 @@
|
|
|
47
50
|
"devDependencies": {
|
|
48
51
|
"@rollup/plugin-terser": "^1.0.0",
|
|
49
52
|
"@rollup/plugin-typescript": "^12.3.0",
|
|
50
|
-
"
|
|
53
|
+
"@vitest/coverage-v8": "5.0.0",
|
|
54
|
+
"oxlint": "^1.82.0",
|
|
51
55
|
"prettier": "^3.9.6",
|
|
52
56
|
"rollup": "^4.60.0",
|
|
53
57
|
"tslib": "^2.8.1",
|
|
54
58
|
"typedoc": "^0.28.18",
|
|
55
59
|
"typescript": "^5.9.3",
|
|
56
|
-
"vitest": "^
|
|
60
|
+
"vitest": "^5.0.0"
|
|
57
61
|
}
|
|
58
62
|
}
|