@devrals/math 0.1.2 → 0.2.1

package/dist/math.js

@@ -6,9 +6,12 @@ var e = class e {
 	static initial(t) {
 		return new e(t, t);
 	}
-	static empty() {
+	static zero() {
 		return new e(0, 0);
 	}
+	static one() {
+		return new e(1, 1);
+	}
 	add(e) {
 		return typeof e == "number" ? this.x += e : this.x += e.x, typeof e == "number" ? this.y += e : this.y += e.y, this;
 	}
@@ -21,6 +24,12 @@ var e = class e {
 	div(e) {
 		return typeof e == "number" ? this.x /= e : this.x /= e.x, typeof e == "number" ? this.y /= e : this.y /= e.y, this;
 	}
+	dot(e) {
+		return this.x * e.x + this.y * e.y;
+	}
+	cross(e) {
+		return this.x * e.y - this.y * e.x;
+	}
 	map(e) {
 		return this.x = e(this.x), this.y = e(this.y), this;
 	}
@@ -31,18 +40,38 @@ var e = class e {
 			0
 		];
 	}
-}, t = class t extends e {
+	length() {
+		return Math.hypot(this.x, this.y);
+	}
+	lengthSquared() {
+		return this.x * this.x + this.y * this.y;
+	}
+	normalize() {
+		let e = this.length();
+		return e !== 0 && this.div(e), this;
+	}
+	distance(e) {
+		let t = e.x - this.x, n = e.y - this.y;
+		return Math.hypot(t, n);
+	}
+	clone() {
+		return new e(this.x, this.y);
+	}
+}, t = class e {
 	constructor(e, t, n) {
-		super(e, t), this.z = n;
+		this.x = e, this.y = t, this.z = n;
 	}
-	static initial(e) {
-		return new t(e, e, e);
+	static initial(t) {
+		return new e(t, t, t);
 	}
-	static empty() {
-		return new t(0, 0, 0);
+	static zero() {
+		return e.initial(0);
 	}
-	static fromHex(e) {
-		return new t(parseInt(e.slice(0, 2), 16), parseInt(e.slice(2, 4), 16), parseInt(e.slice(4, 6), 16));
+	static one() {
+		return e.initial(1);
+	}
+	static fromHex(t) {
+		return new e(parseInt(t.slice(0, 2), 16), parseInt(t.slice(2, 4), 16), parseInt(t.slice(4, 6), 16));
 	}
 	add(e) {
 		return typeof e == "number" ? this.x += e : this.x += e.x, typeof e == "number" ? this.y += e : this.y += e.y, typeof e == "number" ? this.z += e : this.z += e.z, this;
@@ -56,6 +85,12 @@ var e = class e {
 	div(e) {
 		return typeof e == "number" ? this.x /= e : this.x /= e.x, typeof e == "number" ? this.y /= e : this.y /= e.y, typeof e == "number" ? this.z /= e : this.z /= e.z, this;
 	}
+	dot(e) {
+		return this.x * e.x + this.y * e.y + this.z * e.z;
+	}
+	cross(t) {
+		return new e(this.y * t.z - this.z * t.y, this.z * t.x - this.x * t.z, this.x * t.y - this.y * t.x);
+	}
 	map(e) {
 		return this.x = e(this.x), this.y = e(this.y), this.z = e(this.z), this;
 	}
@@ -66,6 +101,26 @@ var e = class e {
 			this.z
 		];
 	}
-}, n = (e) => e[Math.floor(Math.random() * e.length)], r = (e, t) => (e % t + t) % t, i = (e, t) => e + Math.random() * (t - e), a = (e, t, n) => Math.max(Math.min(e, n), t), o = (e, t, n) => e * (1 - n) + t * n, s = (e, t, n) => e < t ? Math.min(e + n, t) : Math.max(e - n, t), c = (n, r) => "z" in n && "z" in r ? new t(n.x + r.x, n.y + n.y, n.z + n.z) : new e(n.x + r.x, n.y + n.y), l = (n, r) => "z" in n && "z" in r ? new t(n.x - r.x, n.y - n.y, n.z - n.z) : new e(n.x - r.x, n.y - n.y), u = (n, r) => "z" in n && "z" in r ? new t(n.x * r.x, n.y * n.y, n.z * n.z) : new e(n.x * r.x, n.y * n.y), d = (n, r) => "z" in n && "z" in r ? new t(n.x / r.x, n.y / n.y, n.z / n.z) : new e(n.x / r.x, n.y / n.y);
+	length() {
+		return Math.hypot(this.x, this.y, this.z);
+	}
+	lengthSquared() {
+		return this.x * this.x + this.y * this.y + this.z * this.z;
+	}
+	normalize() {
+		let e = this.length();
+		return e !== 0 && this.div(e), this;
+	}
+	distance(e) {
+		let t = e.x - this.x, n = e.y - this.y, r = e.z - this.z;
+		return Math.hypot(t, n, r);
+	}
+	clone() {
+		return new e(this.x, this.y, this.z);
+	}
+}, n = (e) => {
+	if (e.length > 0) return e[Math.floor(Math.random() * e.length)];
+	throw Error("`chooseRand` recived an empty array which is not approved");
+}, r = (e, t) => (e % t + t) % t, i = (e, t) => e + Math.random() * (t - e), a = (e, t, n) => Math.max(Math.min(e, n), t), o = (e, t, n) => e * (1 - n) + t * n, s = (e, t, n) => e < t ? Math.min(e + n, t) : Math.max(e - n, t), c = (e, t) => e.clone().add(t), l = (e, t) => e.clone().sub(t), u = (e, t) => e.clone().mul(t), d = (e, t) => e.clone().div(t);
 //#endregion
 export { e as Vec2, t as Vec3, c as add, s as approach, n as chooseRand, a as clamp, d as div, o as lerp, r as mod, u as mul, i as randRange, l as sub };

package/dist/math.umd.cjs

@@ -1 +1 @@
-(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.index={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=class e{constructor(e,t){this.x=e,this.y=t}static initial(t){return new e(t,t)}static empty(){return new e(0,0)}add(e){return typeof e==`number`?this.x+=e:this.x+=e.x,typeof e==`number`?this.y+=e:this.y+=e.y,this}sub(e){return typeof e==`number`?this.x-=e:this.x-=e.x,typeof e==`number`?this.y-=e:this.y-=e.y,this}mul(e){return typeof e==`number`?this.x*=e:this.x*=e.x,typeof e==`number`?this.y*=e:this.y*=e.y,this}div(e){return typeof e==`number`?this.x/=e:this.x/=e.x,typeof e==`number`?this.y/=e:this.y/=e.y,this}map(e){return this.x=e(this.x),this.y=e(this.y),this}toArr(){return[this.x,this.y,0]}},n=class e extends t{constructor(e,t,n){super(e,t),this.z=n}static initial(t){return new e(t,t,t)}static empty(){return new e(0,0,0)}static fromHex(t){return new e(parseInt(t.slice(0,2),16),parseInt(t.slice(2,4),16),parseInt(t.slice(4,6),16))}add(e){return typeof e==`number`?this.x+=e:this.x+=e.x,typeof e==`number`?this.y+=e:this.y+=e.y,typeof e==`number`?this.z+=e:this.z+=e.z,this}sub(e){return typeof e==`number`?this.x-=e:this.x-=e.x,typeof e==`number`?this.y-=e:this.y-=e.y,typeof e==`number`?this.z-=e:this.z-=e.z,this}mul(e){return this.x*=typeof e==`number`?e:e.x,this.y*=typeof e==`number`?e:e.y,this.z*=typeof e==`number`?e:e.z,this}div(e){return typeof e==`number`?this.x/=e:this.x/=e.x,typeof e==`number`?this.y/=e:this.y/=e.y,typeof e==`number`?this.z/=e:this.z/=e.z,this}map(e){return this.x=e(this.x),this.y=e(this.y),this.z=e(this.z),this}toArr(){return[this.x,this.y,this.z]}};e.Vec2=t,e.Vec3=n,e.add=(e,r)=>`z`in e&&`z`in r?new n(e.x+r.x,e.y+e.y,e.z+e.z):new t(e.x+r.x,e.y+e.y),e.approach=(e,t,n)=>e<t?Math.min(e+n,t):Math.max(e-n,t),e.chooseRand=e=>e[Math.floor(Math.random()*e.length)],e.clamp=(e,t,n)=>Math.max(Math.min(e,n),t),e.div=(e,r)=>`z`in e&&`z`in r?new n(e.x/r.x,e.y/e.y,e.z/e.z):new t(e.x/r.x,e.y/e.y),e.lerp=(e,t,n)=>e*(1-n)+t*n,e.mod=(e,t)=>(e%t+t)%t,e.mul=(e,r)=>`z`in e&&`z`in r?new n(e.x*r.x,e.y*e.y,e.z*e.z):new t(e.x*r.x,e.y*e.y),e.randRange=(e,t)=>e+Math.random()*(t-e),e.sub=(e,r)=>`z`in e&&`z`in r?new n(e.x-r.x,e.y-e.y,e.z-e.z):new t(e.x-r.x,e.y-e.y)});
+(function(e,t){typeof exports==`object`&&typeof module<`u`?t(exports):typeof define==`function`&&define.amd?define([`exports`],t):(e=typeof globalThis<`u`?globalThis:e||self,t(e.index={}))})(this,function(e){Object.defineProperty(e,Symbol.toStringTag,{value:`Module`});var t=class e{constructor(e,t){this.x=e,this.y=t}static initial(t){return new e(t,t)}static zero(){return new e(0,0)}static one(){return new e(1,1)}add(e){return typeof e==`number`?this.x+=e:this.x+=e.x,typeof e==`number`?this.y+=e:this.y+=e.y,this}sub(e){return typeof e==`number`?this.x-=e:this.x-=e.x,typeof e==`number`?this.y-=e:this.y-=e.y,this}mul(e){return typeof e==`number`?this.x*=e:this.x*=e.x,typeof e==`number`?this.y*=e:this.y*=e.y,this}div(e){return typeof e==`number`?this.x/=e:this.x/=e.x,typeof e==`number`?this.y/=e:this.y/=e.y,this}dot(e){return this.x*e.x+this.y*e.y}cross(e){return this.x*e.y-this.y*e.x}map(e){return this.x=e(this.x),this.y=e(this.y),this}toArr(){return[this.x,this.y,0]}length(){return Math.hypot(this.x,this.y)}lengthSquared(){return this.x*this.x+this.y*this.y}normalize(){let e=this.length();return e!==0&&this.div(e),this}distance(e){let t=e.x-this.x,n=e.y-this.y;return Math.hypot(t,n)}clone(){return new e(this.x,this.y)}},n=class e{constructor(e,t,n){this.x=e,this.y=t,this.z=n}static initial(t){return new e(t,t,t)}static zero(){return e.initial(0)}static one(){return e.initial(1)}static fromHex(t){return new e(parseInt(t.slice(0,2),16),parseInt(t.slice(2,4),16),parseInt(t.slice(4,6),16))}add(e){return typeof e==`number`?this.x+=e:this.x+=e.x,typeof e==`number`?this.y+=e:this.y+=e.y,typeof e==`number`?this.z+=e:this.z+=e.z,this}sub(e){return typeof e==`number`?this.x-=e:this.x-=e.x,typeof e==`number`?this.y-=e:this.y-=e.y,typeof e==`number`?this.z-=e:this.z-=e.z,this}mul(e){return this.x*=typeof e==`number`?e:e.x,this.y*=typeof e==`number`?e:e.y,this.z*=typeof e==`number`?e:e.z,this}div(e){return typeof e==`number`?this.x/=e:this.x/=e.x,typeof e==`number`?this.y/=e:this.y/=e.y,typeof e==`number`?this.z/=e:this.z/=e.z,this}dot(e){return this.x*e.x+this.y*e.y+this.z*e.z}cross(t){return new e(this.y*t.z-this.z*t.y,this.z*t.x-this.x*t.z,this.x*t.y-this.y*t.x)}map(e){return this.x=e(this.x),this.y=e(this.y),this.z=e(this.z),this}toArr(){return[this.x,this.y,this.z]}length(){return Math.hypot(this.x,this.y,this.z)}lengthSquared(){return this.x*this.x+this.y*this.y+this.z*this.z}normalize(){let e=this.length();return e!==0&&this.div(e),this}distance(e){let t=e.x-this.x,n=e.y-this.y,r=e.z-this.z;return Math.hypot(t,n,r)}clone(){return new e(this.x,this.y,this.z)}};e.Vec2=t,e.Vec3=n,e.add=(e,t)=>e.clone().add(t),e.approach=(e,t,n)=>e<t?Math.min(e+n,t):Math.max(e-n,t),e.chooseRand=e=>{if(e.length>0)return e[Math.floor(Math.random()*e.length)];throw Error("`chooseRand` recived an empty array which is not approved")},e.clamp=(e,t,n)=>Math.max(Math.min(e,n),t),e.div=(e,t)=>e.clone().div(t),e.lerp=(e,t,n)=>e*(1-n)+t*n,e.mod=(e,t)=>(e%t+t)%t,e.mul=(e,t)=>e.clone().mul(t),e.randRange=(e,t)=>e+Math.random()*(t-e),e.sub=(e,t)=>e.clone().sub(t)});

package/dist/src/functions.d.ts

@@ -1,11 +1,17 @@
 import { Vec2, Vec3 } from './vectors.js';
+/**
+ *
+ * @param arr
+ * @returns A random object from the given list
+ * @throws An `Error` object if the `arr` is empty
+ */
 export declare const chooseRand: <T>(arr: T[]) => T;
 export declare const mod: (x: number, m: number) => number;
 export declare const randRange: (min: number, max: number) => number;
 export declare const clamp: (value: number, min: number, max: number) => number;
 export declare const lerp: (a: number, b: number, t: number) => number;
 export declare const approach: (current: number, target: number, dt: number) => number;
-export declare const add: <V extends Vec2 | Vec3>(x: V, y: V) => V;
-export declare const sub: <V extends Vec2 | Vec3>(x: V, y: V) => V;
-export declare const mul: <V extends Vec2 | Vec3>(x: V, y: V) => V;
-export declare const div: <V extends Vec2 | Vec3>(x: V, y: V) => V;
+export declare const add: <V extends Vec2 | Vec3>(a: V, b: V) => V;
+export declare const sub: <V extends Vec2 | Vec3>(a: V, b: V) => V;
+export declare const mul: <V extends Vec2 | Vec3>(a: V, b: V) => V;
+export declare const div: <V extends Vec2 | Vec3>(a: V, b: V) => V;

package/dist/src/index.d.ts

@@ -1,2 +1,3 @@
 export * from './vectors.js';
 export * from './functions.js';
+export * from './types.js';

package/dist/src/tests/functions.test.d.ts

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

package/dist/src/tests/vectors.test.d.ts

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

package/dist/src/types.d.ts

@@ -0,0 +1,11 @@
+import { Vec2, Vec3 } from './vectors.js';
+export type VertexPositionColorTexture = {
+    pos: Vec2;
+    color: Vec3;
+    uv: Vec2;
+    alpha: number;
+};
+export type VertexPositionColor = {
+    pos: Vec2;
+    color: Vec3;
+};

package/dist/src/vectors.d.ts

@@ -3,34 +3,114 @@ export declare class Vec2 {
     y: number;
     constructor(x: number, y: number);
     static initial(v: number): Vec2;
-    static empty(): Vec2;
+    static zero(): Vec2;
+    static one(): Vec2;
     add(other: Vec2 | number): this;
     sub(other: Vec2 | number): this;
     mul(other: Vec2 | number): this;
     div(other: Vec2 | number): this;
+    /**
+     * @returns Dot product of `this` and `other`
+     */
+    dot(other: Vec2): number;
+    /**
+     * @returns the cross product of `this` and `other`
+     */
+    cross(other: Vec2): number;
+    /**
+     * `cb` applied to the `x` and `y`
+     */
     map(cb: (v: number) => number): this;
+    /**
+     * @returns \[`x`, `y`, 0\]
+     */
     toArr(): [number, number, number];
+    /**
+     * @returns magnitude of the vector
+     */
+    length(): number;
+    /**
+     * Consider using this over `length` if you want faster calculations
+     * @returns squared magnitude of the vector
+     */
+    lengthSquared(): number;
+    /**
+     * Normalizes the vector
+     * @example
+     *  const vec = new Vec2(5, 0)
+     *  vec.normalize()
+     *  console.assert(vec, new Vec2(1, 0))
+     */
+    normalize(): this;
+    distance(target: Vec2): number;
+    /**
+     * @returns A deep copy of this vector
+     */
+    clone(): Vec2;
 }
-export declare class Vec3 extends Vec2 {
+export declare class Vec3 {
+    x: number;
+    y: number;
     z: number;
     constructor(x: number, y: number, z: number);
     static initial(v: number): Vec3;
-    static empty(): Vec3;
+    static zero(): Vec3;
+    static one(): Vec3;
+    /**
+     *
+     * @param value HEX string without the char '#'
+     * @example
+     *
+     * const white = Vec3.fromHex("ffffff");
+     * const black = Vec3.fromHex("000000");
+     * const blue = Vec3.fromHex("0000ff");
+     *
+     * console.assert(white, new Vec3(255, 255, 255))
+     * console.assert(black, new Vec3(0, 0, 0))
+     * console.assert(blue, new Vec3(0, 0, 255))
+     */
     static fromHex(value: string): Vec3;
     add(other: Vec3 | number): this;
     sub(other: Vec3 | number): this;
     mul(other: Vec3 | number): this;
     div(other: Vec3 | number): this;
+    /**
+     * @returns Dot product of this vector
+     */
+    dot(other: Vec3): number;
+    /**
+     * `Vec3.cross` doesn't update for the current value.
+     * Instead returns the calculated value
+     */
+    cross(other: Vec3): Vec3;
+    /**
+     * `cb` applied to the `x`, `y` and `z`
+     */
     map(cb: (v: number) => number): this;
+    /**
+     * @returns \[`x`, `y`, `z`\]
+     */
     toArr(): [number, number, number];
+    /**
+     * @returns magnitude of the vector
+     */
+    length(): number;
+    /**
+     * Consider using this over `length` if you want faster calculations
+     * @returns squared magnitude of the vector
+     */
+    lengthSquared(): number;
+    /**
+     * Normalizes the vector
+     * @example
+     *  const vec = new Vec3(5, 0, 0)
+     *  vec.normalize()
+     *  console.assert(vec, new Vec3(1, 0, 0))
+     */
+    normalize(): this;
+    distance(target: Vec3): number;
+    /**
+     * @returns A deep copy of this vector
+     */
+    clone(): Vec3;
 }
-export type VertexPositionColorTexture = {
-    pos: Vec2;
-    color: Vec3;
-    uv: Vec2;
-    alpha: number;
-};
-export type VertexPositionColor = {
-    pos: Vec2;
-    color: Vec3;
-};

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "@devrals/math",
-  "version": "0.1.2",
+  "version": "0.2.1",
   "type": "module",
   "license": "MIT",
   "description": "Vector2/3 Utils",
-  "repository": "https://github.com/devRals/webgl-backdrops/",
   "files": [
     "dist"
   ],
@@ -14,7 +13,8 @@
   },
   "keywords": [
     "math",
-    "vec2"
+    "vec2",
+    "vec3"
   ],
   "exports": {
     ".": {
@@ -23,6 +23,7 @@
     }
   },
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "test": "vitest"
   }
 }