Add Vector and Matrix compare, equal and equals with epsilon parameter (#48)

* Add Vector and Matrix compare, equal and equals with epsilon parameter

* Add Quaternion compare, equal and equals with epsilon parameter

* Use normalized Quaternion when comparing them

* Cleanup + Change to compareTo + Remove normalizing + Fixes

Author: ThomasGorisse

src/commonMain/kotlin/dev/romainguy/kotlin/math/Matrix.kt

@@ -85,6 +85,12 @@ data class Mat2(
     operator fun minus(v: Float) = Mat2(x - v, y - v)
     operator fun times(v: Float) = Mat2(x * v, y * v)
     operator fun div(v: Float) = Mat2(x / v, y / v)
+    inline fun compareTo(v: Float, delta: Float = 0.0f) = Mat2(
+        x.compareTo(v, delta),
+        y.compareTo(v, delta)
+    )
+
+    inline fun equals(v: Float, delta: Float = 0.0f) = x.equals(v, delta) && y.equals(v, delta)
 
     operator fun times(m: Mat2) = Mat2(
             Float2(
@@ -97,12 +103,18 @@ data class Mat2(
             )
     )
 
+    inline fun compareTo(m: Mat2, delta: Float = 0.0f) = Mat2(
+        x.compareTo(m.x, delta),
+        y.compareTo(m.y, delta)
+    )
+
+    inline fun equals(m: Mat2, delta: Float = 0.0f) = x.equals(m.x, delta) && y.equals(m.y, delta)
+
     operator fun times(v: Float2) = Float2(
             x.x * v.x + y.x * v.y,
             x.y * v.x + y.y * v.y,
     )
 
-
     fun toFloatArray() = floatArrayOf(
             x.x, y.x,
             x.y, y.y
@@ -114,7 +126,6 @@ data class Mat2(
             |${x.y} ${y.y}|
             """.trimIndent()
     }
-
 }
 
 data class Mat3(
@@ -170,6 +181,14 @@ data class Mat3(
     operator fun minus(v: Float) = Mat3(x - v, y - v, z - v)
     operator fun times(v: Float) = Mat3(x * v, y * v, z * v)
     operator fun div(v: Float) = Mat3(x / v, y / v, z / v)
+    inline fun compareTo(v: Float, delta: Float = 0.0f) = Mat3(
+        x.compareTo(v, delta),
+        y.compareTo(v, delta),
+        z.compareTo(v, delta)
+    )
+
+    inline fun equals(v: Float, delta: Float = 0.0f) =
+        x.equals(v, delta) && y.equals(v, delta) && z.equals(v, delta)
 
     operator fun times(m: Mat3) = Mat3(
             Float3(
@@ -189,6 +208,15 @@ data class Mat3(
             )
     )
 
+    inline fun compareTo(m: Mat3, delta: Float = 0.0f) = Mat3(
+        x.compareTo(m.x, delta),
+        y.compareTo(m.y, delta),
+        z.compareTo(m.z, delta)
+    )
+
+    inline fun equals(m: Mat3, delta: Float = 0.0f) =
+        x.equals(m.x, delta) && y.equals(m.y, delta) && z.equals(m.z, delta)
+
     operator fun times(v: Float3) = Float3(
             x.x * v.x + y.x * v.y + z.x * v.z,
             x.y * v.x + y.y * v.y + z.y * v.z,
@@ -311,6 +339,15 @@ data class Mat4(
     operator fun minus(v: Float) = Mat4(x - v, y - v, z - v, w - v)
     operator fun times(v: Float) = Mat4(x * v, y * v, z * v, w * v)
     operator fun div(v: Float) = Mat4(x / v, y / v, z / v, w / v)
+    inline fun compareTo(v: Float, delta: Float = 0.0f) = Mat4(
+        x.compareTo(v, delta),
+        y.compareTo(v, delta),
+        z.compareTo(v, delta),
+        w.compareTo(v, delta)
+    )
+
+    inline fun equals(v: Float, delta: Float = 0.0f) =
+        x.equals(v, delta) && y.equals(v, delta) && z.equals(v, delta) && w.equals(v, delta)
 
     operator fun times(m: Mat4) = Mat4(
             Float4(
@@ -339,6 +376,16 @@ data class Mat4(
             )
     )
 
+    inline fun compareTo(m: Mat4, delta: Float = 0.0f) = Mat4(
+        x.compareTo(m.x, delta),
+        y.compareTo(m.y, delta),
+        z.compareTo(m.z, delta),
+        w.compareTo(m.w, delta)
+    )
+
+    inline fun equals(m: Mat4, delta: Float = 0.0f) =
+        x.equals(m.x, delta) && y.equals(m.y, delta) && z.equals(m.z, delta) && w.equals(m.w, delta)
+
     operator fun times(v: Float4) = Float4(
             x.x * v.x + y.x * v.y + z.x * v.z+ w.x * v.w,
             x.y * v.x + y.y * v.y + z.y * v.z+ w.y * v.w,
@@ -385,6 +432,78 @@ data class Mat4(
     }
 }
 
+inline fun equal(a: Mat2, b: Float, delta: Float = 0.0f) = Bool2(
+    a.x.equals(b, delta),
+    a.y.equals(b, delta)
+)
+
+inline fun equal(a: Mat2, b: Mat2, delta: Float = 0.0f) = Bool2(
+    a.x.equals(b.x, delta),
+    a.y.equals(b.y, delta)
+)
+
+inline fun notEqual(a: Mat2, b: Float, delta: Float = 0.0f) = Bool2(
+    !a.x.equals(b, delta),
+    !a.y.equals(b, delta)
+)
+
+inline fun notEqual(a: Mat2, b: Mat2, delta: Float = 0.0f) = Bool2(
+    !a.x.equals(b.x, delta),
+    !a.y.equals(b.y, delta)
+)
+
+inline fun equal(a: Mat3, b: Float, delta: Float = 0.0f) = Bool3(
+    a.x.equals(b, delta),
+    a.y.equals(b, delta),
+    a.z.equals(b, delta)
+)
+
+inline fun equal(a: Mat3, b: Mat3, delta: Float = 0.0f) = Bool3(
+    a.x.equals(b.x, delta),
+    a.y.equals(b.y, delta),
+    a.z.equals(b.z, delta)
+)
+
+inline fun notEqual(a: Mat3, b: Float, delta: Float = 0.0f) = Bool3(
+    !a.x.equals(b, delta),
+    !a.y.equals(b, delta),
+    !a.z.equals(b, delta)
+)
+
+inline fun notEqual(a: Mat3, b: Mat3, delta: Float = 0.0f) = Bool3(
+    !a.x.equals(b.x, delta),
+    !a.y.equals(b.y, delta),
+    !a.z.equals(b.z, delta)
+)
+
+inline fun equal(a: Mat4, b: Float, delta: Float = 0.0f) = Bool4(
+    a.x.equals(b, delta),
+    a.y.equals(b, delta),
+    a.z.equals(b, delta),
+    a.w.equals(b, delta)
+)
+
+inline fun equal(a: Mat4, b: Mat4, delta: Float = 0.0f) = Bool4(
+    a.x.equals(b.x, delta),
+    a.y.equals(b.y, delta),
+    a.z.equals(b.z, delta),
+    a.w.equals(b.w, delta)
+)
+
+inline fun notEqual(a: Mat4, b: Float, delta: Float = 0.0f) = Bool4(
+    !a.x.equals(b, delta),
+    !a.y.equals(b, delta),
+    !a.z.equals(b, delta),
+    !a.w.equals(b, delta)
+)
+
+inline fun notEqual(a: Mat4, b: Mat4, delta: Float = 0.0f) = Bool4(
+    !a.x.equals(b.x, delta),
+    !a.y.equals(b.y, delta),
+    !a.z.equals(b.z, delta),
+    !a.w.equals(b.w, delta)
+)
+
 fun transpose(m: Mat2) = Mat2(
         Float2(m.x.x, m.y.x),
         Float2(m.x.y, m.y.y)

src/commonMain/kotlin/dev/romainguy/kotlin/math/Quaternion.kt

@@ -263,6 +263,8 @@ data class Quaternion(
     inline operator fun minus(v: Float) = Quaternion(x - v, y - v, z - v, w - v)
     inline operator fun times(v: Float) = Quaternion(x * v, y * v, z * v, w * v)
     inline operator fun div(v: Float) = Quaternion(x / v, y / v, z / v, w / v)
+    inline fun compareTo(v: Float, delta: Float = 0.0f) = xyzw.compareTo(v, delta)
+    inline fun equals(v: Float, delta: Float = 0.0f) = xyzw.equals(v, delta)
 
     inline operator fun times(v: Float3) = (this * Quaternion(v, 0.0f) * inverse(this)).xyz
 
@@ -274,6 +276,9 @@ data class Quaternion(
             w * q.z + x * q.y - y * q.x + z * q.w,
             w * q.w - x * q.x - y * q.y - z * q.z)
 
+    inline fun compareTo(v: Float4, delta: Float = 0.0f) = xyzw.compareTo(v.xyzw, delta)
+    inline fun equals(v: Float4, delta: Float = 0.0f) = xyzw.equals(v.xyzw, delta)
+
     inline fun transform(block: (Float) -> Float): Quaternion {
         x = block(x)
         y = block(y)
@@ -294,6 +299,32 @@ inline operator fun Float.minus(q: Quaternion) = Quaternion(this - q.x, this - q
 inline operator fun Float.times(q: Quaternion) = Quaternion(this * q.x, this * q.y, this * q.z, this * q.w)
 inline operator fun Float.div(q: Quaternion) = Quaternion(this / q.x, this / q.y, this / q.z, this / q.w)
 
+inline fun lessThan(a: Quaternion, b: Float) = lessThan(a.xyzw, b)
+inline fun lessThan(a: Quaternion, b: Quaternion) = lessThan(a.xyzw, b.xyzw)
+inline fun lessThanEqual(a: Quaternion, b: Float) = lessThanEqual(a.xyzw, b)
+inline fun lessThanEqual(a: Quaternion, b: Quaternion) = lessThanEqual(a.xyzw, b.xyzw)
+inline fun greaterThan(a: Quaternion, b: Float) = greaterThan(a.xyzw, b)
+inline fun greaterThan(a: Quaternion, b: Quaternion) = greaterThan(a.xyzw, b.xyzw)
+inline fun greaterThanEqual(a: Quaternion, b: Float) = greaterThanEqual(a.xyzw, b)
+inline fun greaterThanEqual(a: Quaternion, b: Quaternion) = greaterThanEqual(a.xyzw, b.xyzw)
+inline fun equal(a: Quaternion, b: Float) = equal(a.xyzw, b)
+inline fun equal(a: Quaternion, b: Quaternion) = equal(a.xyzw, b.xyzw)
+inline fun notEqual(a: Quaternion, b: Float) = notEqual(a.xyzw, b)
+inline fun notEqual(a: Quaternion, b: Quaternion) = notEqual(a.xyzw, b.xyzw)
+
+inline infix fun Quaternion.lt(b: Float) = xyzw.lt(b)
+inline infix fun Quaternion.lt(b: Float4) = xyzw.lt(b.xyzw)
+inline infix fun Quaternion.lte(b: Float) = xyzw.lte(b)
+inline infix fun Quaternion.lte(b: Float4) = xyzw.lte(b.xyzw)
+inline infix fun Quaternion.gt(b: Float) = xyzw.gt(b)
+inline infix fun Quaternion.gt(b: Float4) = xyzw.gt(b.xyzw)
+inline infix fun Quaternion.gte(b: Float) = xyzw.gte(b)
+inline infix fun Quaternion.gte(b: Float4) = xyzw.gte(b.xyzw)
+inline infix fun Quaternion.eq(b: Float) = xyzw.eq(b)
+inline infix fun Quaternion.eq(b: Float4) = xyzw.eq(b.xyzw)
+inline infix fun Quaternion.neq(b: Float) = xyzw.neq(b)
+inline infix fun Quaternion.neq(b: Float4) = xyzw.neq(b.xyzw)
+
 inline fun abs(q: Quaternion) = Quaternion(abs(q.x), abs(q.y), abs(q.z), abs(q.w))
 inline fun length(q: Quaternion) = sqrt(q.x * q.x + q.y * q.y + q.z * q.z + q.w * q.w)
 inline fun length2(q: Quaternion) = q.x * q.x + q.y * q.y + q.z * q.z + q.w * q.w