[orx-kdtree] Make orx-kdtree a multiplatform module

gradle/libs.versions.toml

@@ -51,6 +51,7 @@ kotest-framework-engine = { group = "io.kotest", name = "kotest-framework-engine
 openrndr-application = { group = "org.openrndr", name = "openrndr-application", version.ref = "openrndr" }
 openrndr-extensions = { group = "org.openrndr", name = "openrndr-extensions", version.ref = "openrndr" }
 openrndr-math = { group = "org.openrndr", name = "openrndr-math", version.ref = "openrndr" }
+openrndr-utils = { group = "org.openrndr", name = "openrndr-utils", version.ref = "openrndr" }
 openrndr-shape = { group = "org.openrndr", name = "openrndr-shape", version.ref = "openrndr" }
 openrndr-draw = { group = "org.openrndr", name = "openrndr-draw", version.ref = "openrndr" }
 openrndr-event = { group = "org.openrndr", name = "openrndr-event", version.ref = "openrndr" }

orx-kdtree/README.md

@@ -5,16 +5,16 @@ Fast search of points closest to the queried point in a data set. 2D, 3D and 4D.
 <!-- __demos__ -->
 ## Demos
 ### DemoKNearestNeighbour01
-[source code](src/demo/kotlin/DemoKNearestNeighbour01.kt)
+[source code](src/jvmDemo/kotlin/DemoKNearestNeighbour01.kt)
 
 ![DemoKNearestNeighbour01Kt](https://raw.githubusercontent.com/openrndr/orx/media/orx-kdtree/images/DemoKNearestNeighbour01Kt.png)
 
 ### DemoNearestNeighbour01
-[source code](src/demo/kotlin/DemoNearestNeighbour01.kt)
+[source code](src/jvmDemo/kotlin/DemoNearestNeighbour01.kt)
 
 ![DemoNearestNeighbour01Kt](https://raw.githubusercontent.com/openrndr/orx/media/orx-kdtree/images/DemoNearestNeighbour01Kt.png)
 
 ### DemoRangeQuery01
-[source code](src/demo/kotlin/DemoRangeQuery01.kt)
+[source code](src/jvmDemo/kotlin/DemoRangeQuery01.kt)
 
 ![DemoRangeQuery01Kt](https://raw.githubusercontent.com/openrndr/orx/media/orx-kdtree/images/DemoRangeQuery01Kt.png)

orx-kdtree/build.gradle.kts

@@ -1,15 +1,23 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
-    org.openrndr.extra.convention.`kotlin-jvm`
+    org.openrndr.extra.convention.`kotlin-multiplatform`
 }
 
-tasks.withType<KotlinCompile> {
+
-    kotlinOptions.freeCompilerArgs = listOf("-opt-in=kotlin.RequiresOptIn")
+kotlin {
+    sourceSets {
+        val commonMain by getting {
+            dependencies {
+                implementation(libs.openrndr.application)
+                api(libs.openrndr.math)
+                implementation(libs.kotlin.coroutines)
+                api(libs.openrndr.utils)
+            }
+        }
+    }
 }
 
-dependencies {
+
-    implementation(libs.openrndr.application)
+
-    implementation(libs.openrndr.math)
+//tasks.withType<KotlinCompile> {
-    implementation(libs.kotlin.coroutines)
+//    kotlinOptions.freeCompilerArgs = listOf("-opt-in=kotlin.RequiresOptIn")
-}
+//}

orx-kdtree/src/commonMain/kotlin/KDTree.kt

@@ -1,45 +1,10 @@
 package org.openrndr.extra.kdtree
 
-import kotlinx.coroutines.*
+
-import org.openrndr.math.*
+import org.openrndr.collections.PriorityQueue
-import java.util.*
-import kotlin.IllegalStateException
 import kotlin.math.abs
 
-/** built-in mapper for [Vector2] */
-fun vector2Mapper(v: Vector2, dimension: Int): Double {
-    return when (dimension) {
-        0 -> v.x
-        else -> v.y
-    }
-}
 
-fun intVector2Mapper(v: IntVector2, dimension: Int): Double {
-    return when (dimension) {
-        0 -> v.x.toDouble()
-        else -> v.y.toDouble()
-    }
-}
-
-
-/** built-in mapper for [Vector3] */
-fun vector3Mapper(v: Vector3, dimension: Int): Double {
-    return when (dimension) {
-        0 -> v.x
-        1 -> v.y
-        else -> v.z
-    }
-}
-
-/** built-in mapper for [Vector4] */
-fun vector4Mapper(v: Vector4, dimension: Int): Double {
-    return when (dimension) {
-        0 -> v.x
-        1 -> v.y
-        2 -> v.z
-        else -> v.w
-    }
-}
 
 class KDTreeNode<T>(val dimensions: Int, val mapper: (T, Int) -> Double) {
     var parent: KDTreeNode<T>? = null
@@ -76,8 +41,7 @@ class KDTreeNode<T>(val dimensions: Int, val mapper: (T, Int) -> Double) {
                 "median=" + median +
                 ", item=" + item +
                 ", dimension=" + dimension +
-                ", children=" + Arrays.toString(children) +
+                ", children=" + children.joinToString(", ") { it.toString() } +
-
                 "} " + super.toString()
     }
 }
@@ -95,82 +59,8 @@ private fun <T> insertItem(root: KDTreeNode<T>, item: T): KDTreeNode<T> {
     }
 }
 
+expect fun <T> buildKDTree(items: MutableList<T>, dimensions: Int, mapper: (T, Int) -> Double): KDTreeNode<T>
 
-@OptIn(DelicateCoroutinesApi::class)
-fun <T> buildKDTree(items: MutableList<T>, dimensions: Int, mapper: (T, Int) -> Double): KDTreeNode<T> {
-    val root = KDTreeNode<T>(dimensions, mapper)
-
-    fun <T> buildTreeTask(
-        scope: CoroutineScope,
-        node: KDTreeNode<T>,
-        items: MutableList<T>,
-        dimensions: Int,
-        levels: Int,
-        mapper: (T, Int) -> Double
-    ): KDTreeNode<T> {
-
-        if (items.size > 0) {
-            val dimension = levels % dimensions
-            val values = ArrayList<T>()
-            for (item in items) {
-                values.add(item)
-            }
-
-            node.dimension = dimension
-            val median = selectNth(items, items.size / 2) { mapper(it, dimension) }
-
-            val leftItems = mutableListOf<T>()
-            val rightItems = mutableListOf<T>()
-
-            node.median = mapper(median, dimension)
-            node.item = median
-            for (item in items) {
-                if (item === median) {
-                    continue
-                }
-                if (mapper(item, dimension) < node.median) {
-                    leftItems.add(item)
-                } else {
-                    rightItems.add(item)
-                }
-            }
-
-            // validate split
-            if (leftItems.size + rightItems.size + 1 != items.size) {
-                throw IllegalStateException("left: ${leftItems.size}, right: ${rightItems.size}, items: ${items.size}")
-            }
-
-            if (leftItems.size > 0) {
-                node.children[0] = KDTreeNode(dimensions, mapper)
-                node.children[0]?.let {
-                    it.parent = node
-
-                    scope.launch {
-                        buildTreeTask(scope, it, leftItems, dimensions, levels + 1, mapper)
-                    }
-                }
-            }
-            if (rightItems.size > 0) {
-                node.children[1] = KDTreeNode(dimensions, mapper)
-                node.children[1]?.let {
-                    it.parent = node
-                    scope.launch {
-                        buildTreeTask(scope, it, rightItems, dimensions, levels + 1, mapper)
-                    }
-                }
-            }
-        }
-        return node
-    }
-
-    val job = GlobalScope.launch {
-        buildTreeTask(this, root, items, dimensions, 0, mapper)
-    }
-    runBlocking {
-        job.join()
-    }
-    return root
-}
 
 
 private fun <T> sqrDistance(left: T, right: T, dimensions: Int, mapper: (T, Int) -> Double): Double {
@@ -184,20 +74,18 @@ private fun <T> sqrDistance(left: T, right: T, dimensions: Int, mapper: (T, Int)
 }
 
 fun <T> findAllNodes(root: KDTreeNode<T>): List<KDTreeNode<T>> {
-    val stack = Stack<KDTreeNode<T>>()
+    val stack = mutableListOf<KDTreeNode<T>>()
-    val all = ArrayList<KDTreeNode<T>>()
+    val all = mutableListOf<KDTreeNode<T>>()
-    stack.push(root)
+    stack.add(root)
     while (!stack.isEmpty()) {
-        val node = stack.pop()
+        val node = stack.removeLast()
-//        if (node.item != null /*&& !visited.contains(node.children[1])*/) {
         all.add(node)
-//        }
 
-        if (node.children[0] != null  /*&&!visited.contains(node.children[0])*/) {
+        if (node.children[0] != null) {
-            stack.push(node.children[0])
+            stack.add(node.children[0] !!)
         }
         if (node.children[1] != null) {
-            stack.push(node.children[1])
+            stack.add(node.children[1] !!)
         }
     }
     return all
@@ -229,16 +117,16 @@ fun <T> findKNearest(
             val distance = sqrDistance(query, node.item ?: error("item is null"), node.dimensions, node.mapper)
 
             if (includeQuery || node.item !== query) {
-                if (queue.size < k || distance < queue.peek().second) {
+                if (queue.size() < k || distance < queue.peek().second) {
                     queue.add(Pair(node, distance))
-                    if (queue.size > k) {
+                    if (queue.size() > k) {
                         queue.poll()
                     }
                 }
             }
 
             val d = abs(node.median - dimensionValue)
-            if (queue.size < k || d * d < queue.peek().second) {
+            if (queue.size() < k || d * d < queue.peek().second) {
                 nearest(node.children[1 - route])
             }
         }
@@ -253,7 +141,7 @@ fun <T> findKNearest(
 }
 
 private fun <T> findNearest(root: KDTreeNode<T>, query: T, includeQuery: Boolean = false): T? {
-    var nearest = java.lang.Double.POSITIVE_INFINITY
+    var nearest = Double.POSITIVE_INFINITY
     var nearestArg: KDTreeNode<T>? = null
 
     fun nearest(node: KDTreeNode<T>?) {
@@ -309,10 +197,10 @@ private fun <T> findAllInRadius(
         }
 
         val route: Int = if ((dimensionValue < node.median || node.children[1]==null) && node.children[0] != null )  {
-            queue.add(node.children[0])
+            queue.add(node.children[0]!!)
             0
         } else if (node.children[1] != null) {
-            queue.add(node.children[1])
+            queue.add(node.children[1]!!)
             1
         } else {
             -1
@@ -333,18 +221,18 @@ private fun <T> findAllInRadius(
 }
 
 private fun <T> insert(root: KDTreeNode<T>, item: T, dimensions: Int, mapper: (T, Int) -> Double): KDTreeNode<T> {
-    val stack = Stack<KDTreeNode<T>>()
+    val stack = mutableListOf<KDTreeNode<T>>()
-    stack.push(root)
+    stack.add(root)
 
     dive@ while (true) {
 
-        val node = stack.peek()
+        val node = stack.last()
 
         val value = mapper(item, node.dimension)
 
         if (value < node.median) {
             if (node.children[0] != null) {
-                stack.push(node.children[0])
+                stack.add(node.children[0]!!)
             } else {
                 // sit here
                 node.children[0] = KDTreeNode(dimensions, mapper)
@@ -356,7 +244,7 @@ private fun <T> insert(root: KDTreeNode<T>, item: T, dimensions: Int, mapper: (T
             }
         } else {
             if (node.children[1] != null) {
-                stack.push(node.children[1])
+                stack.add(node.children[1]!!)
             } else {
                 // sit here
                 node.children[1] = KDTreeNode(dimensions, mapper)
@@ -387,27 +275,27 @@ private fun <T> remove(toRemove: KDTreeNode<T>, mapper: (T, Int) -> Double): KDT
             toRemove.item = null
         }
     } else {
-        val stack = Stack<KDTreeNode<T>>()
+        val stack = mutableListOf<KDTreeNode<T>>()
 
         var branch = 0
 
         if (toRemove.children[0] != null) {
-            stack.push(toRemove.children[0])
+            stack.add(toRemove.children[0]!!)
             branch = 0
         } else {
-            stack.push(toRemove.children[1])
+            stack.add(toRemove.children[1]!!)
             branch = 1
         }
 
-        var minValue: Double = java.lang.Double.POSITIVE_INFINITY
+        var minValue: Double = Double.POSITIVE_INFINITY
-        var maxValue: Double = java.lang.Double.NEGATIVE_INFINITY
+        var maxValue: Double = Double.NEGATIVE_INFINITY
         var minArg: KDTreeNode<T>? = null
         var maxArg: KDTreeNode<T>? = null
 
         while (!stack.isEmpty()) {
-            val node = stack.pop() ?: throw RuntimeException("null on stack")
+            val node = stack.removeLast()
 
-            val value = mapper(node.item ?: throw IllegalStateException("item is null"), toRemove.dimension)
+            val value = mapper(node.item ?: error("item is null"), toRemove.dimension)
 
             if (value < minValue) {
                 minValue = value
@@ -421,27 +309,27 @@ private fun <T> remove(toRemove: KDTreeNode<T>, mapper: (T, Int) -> Double): KDT
 
             if (node.dimension != toRemove.dimension) {
                 if (node.children[0] != null) {
-                    stack.push(node.children[0])
+                    stack.add(node.children[0]!!)
                 }
                 if (node.children[1] != null) {
-                    stack.push(node.children[1])
+                    stack.add(node.children[1]!!)
                 }
             } else {
                 if (branch == 1) {
                     if (node.children[0] != null) {
-                        stack.push(node.children[0])
+                        stack.add(node.children[0]!!)
                     } else {
                         if (node.children[1] != null) {
-                            stack.push(node.children[1])
+                            stack.add(node.children[1]!!)
                         }
                     }
                 }
                 if (branch == 0) {
                     if (node.children[1] != null) {
-                        stack.push(node.children[1])
+                        stack.add(node.children[1]!!)
                     } else {
                         if (node.children[0] != null) {
-                            stack.push(node.children[0])
+                            stack.add(node.children[0]!!)
                         }
                     }
                 }
@@ -462,21 +350,3 @@ private fun <T> remove(toRemove: KDTreeNode<T>, mapper: (T, Int) -> Double): KDT
     }
     return null
 }
-
-@JvmName("kdTreeVector2")
-fun Iterable<Vector2>.kdTree(): KDTreeNode<Vector2> {
-    val items = this.toMutableList()
-    return buildKDTree(items, 2, ::vector2Mapper)
-}
-
-@JvmName("kdTreeVector3")
-fun Iterable<Vector3>.kdTree(): KDTreeNode<Vector3> {
-    val items = this.toMutableList()
-    return buildKDTree(items, 3, ::vector3Mapper)
-}
-
-@JvmName("kdTreeVector4")
-fun Iterable<Vector4>.kdTree(): KDTreeNode<Vector4> {
-    val items = this.toMutableList()
-    return buildKDTree(items, 4, ::vector4Mapper)
-}

orx-kdtree/src/commonMain/kotlin/Mappers.kt

@@ -0,0 +1,61 @@
+package org.openrndr.extra.kdtree
+import org.openrndr.math.Vector2
+import org.openrndr.math.IntVector2
+import org.openrndr.math.Vector3
+import org.openrndr.math.Vector4
+import kotlin.jvm.JvmName
+
+/** built-in mapper for [Vector2] */
+fun vector2Mapper(v: Vector2, dimension: Int): Double {
+    return when (dimension) {
+        0 -> v.x
+        else -> v.y
+    }
+}
+
+fun intVector2Mapper(v: IntVector2, dimension: Int): Double {
+    return when (dimension) {
+        0 -> v.x.toDouble()
+        else -> v.y.toDouble()
+    }
+}
+
+
+/** built-in mapper for [Vector3] */
+fun vector3Mapper(v: Vector3, dimension: Int): Double {
+    return when (dimension) {
+        0 -> v.x
+        1 -> v.y
+        else -> v.z
+    }
+}
+
+/** built-in mapper for [Vector4] */
+fun vector4Mapper(v: Vector4, dimension: Int): Double {
+    return when (dimension) {
+        0 -> v.x
+        1 -> v.y
+        2 -> v.z
+        else -> v.w
+    }
+}
+
+
+
+@JvmName("kdTreeVector2")
+fun Iterable<Vector2>.kdTree(): KDTreeNode<Vector2> {
+    val items = this.toMutableList()
+    return buildKDTree(items, 2, ::vector2Mapper)
+}
+
+@JvmName("kdTreeVector3")
+fun Iterable<Vector3>.kdTree(): KDTreeNode<Vector3> {
+    val items = this.toMutableList()
+    return buildKDTree(items, 3, ::vector3Mapper)
+}
+
+@JvmName("kdTreeVector4")
+fun Iterable<Vector4>.kdTree(): KDTreeNode<Vector4> {
+    val items = this.toMutableList()
+    return buildKDTree(items, 4, ::vector4Mapper)
+}

orx-kdtree/src/commonMain/kotlin/QuickSelect.kt

@@ -1,37 +1,37 @@
-package org.openrndr.extra.kdtree
+package org.openrndr.extra.kdtree
-
+
-fun <T> selectNth(items: MutableList<T>, n: Int, mapper: (T)->Double): T {
+fun <T> selectNth(items: MutableList<T>, n: Int, mapper: (T)->Double): T {
-    var from = 0
+    var from = 0
-    var to = items.size - 1
+    var to = items.size - 1
-
+
-    // if from == to we reached the kth element
+    // if from == to we reached the kth element
-    while (from < to) {
+    while (from < to) {
-        var r = from
+        var r = from
-        var w = to
+        var w = to
-        val mid = mapper(items[(r + w) / 2])
+        val mid = mapper(items[(r + w) / 2])
-
+
-        // stop when the reader and writer meet
+        // stop when the reader and writer meet
-        while (r < w) {
+        while (r < w) {
-            if (mapper(items[r]) >= mid) { // put the large values at the end
+            if (mapper(items[r]) >= mid) { // put the large values at the end
-                val tmp = items[w]
+                val tmp = items[w]
-                items[w] = items[r]
+                items[w] = items[r]
-                items[r] = tmp
+                items[r] = tmp
-                w--
+                w--
-            } else { // the value is smaller than the pivot, skip
+            } else { // the value is smaller than the pivot, skip
-                r++
+                r++
-            }
+            }
-        }
+        }
-
+
-        // if we stepped up (r++) we need to step one down
+        // if we stepped up (r++) we need to step one down
-        if (mapper(items[r]) > mid)
+        if (mapper(items[r]) > mid)
-            r--
+            r--
-
+
-        // the r pointer is on the end of the first k elements
+        // the r pointer is on the end of the first k elements
-        if (n <= r) {
+        if (n <= r) {
-            to = r
+            to = r
-        } else {
+        } else {
-            from = r + 1
+            from = r + 1
-        }
+        }
-    }
+    }
-    return items[n]
+    return items[n]
 }

orx-kdtree/src/jsMain/kotlin/KDTree.kt

@@ -0,0 +1,71 @@
+package org.openrndr.extra.kdtree
+
+
+actual fun <T> buildKDTree(items: MutableList<T>, dimensions: Int, mapper: (T, Int) -> Double): KDTreeNode<T> {
+    val root = KDTreeNode<T>(dimensions, mapper)
+
+    fun <T> buildTreeTask(
+        node: KDTreeNode<T>,
+        items: MutableList<T>,
+        dimensions: Int,
+        levels: Int,
+        mapper: (T, Int) -> Double
+    ): KDTreeNode<T> {
+
+        if (items.size > 0) {
+            val dimension = levels % dimensions
+            val values = ArrayList<T>()
+            for (item in items) {
+                values.add(item)
+            }
+
+            node.dimension = dimension
+            val median = selectNth(items, items.size / 2) { mapper(it, dimension) }
+
+            val leftItems = mutableListOf<T>()
+            val rightItems = mutableListOf<T>()
+
+            node.median = mapper(median, dimension)
+            node.item = median
+            for (item in items) {
+                if (item === median) {
+                    continue
+                }
+                if (mapper(item, dimension) < node.median) {
+                    leftItems.add(item)
+                } else {
+                    rightItems.add(item)
+                }
+            }
+
+            // validate split
+            if (leftItems.size + rightItems.size + 1 != items.size) {
+                throw IllegalStateException("left: ${leftItems.size}, right: ${rightItems.size}, items: ${items.size}")
+            }
+
+            if (leftItems.size > 0) {
+                node.children[0] = KDTreeNode(dimensions, mapper)
+                node.children[0]?.let {
+                    it.parent = node
+
+
+                    buildTreeTask(it, leftItems, dimensions, levels + 1, mapper)
+
+                }
+            }
+            if (rightItems.size > 0) {
+                node.children[1] = KDTreeNode(dimensions, mapper)
+                node.children[1]?.let {
+                    it.parent = node
+                    buildTreeTask(it, rightItems, dimensions, levels + 1, mapper)
+
+                }
+            }
+        }
+        return node
+    }
+
+
+    buildTreeTask(root, items, dimensions, 0, mapper)
+    return root
+}

orx-kdtree/src/jvmMain/kotlin/KDTree.kt

@@ -0,0 +1,80 @@
+@file:JvmName("KDTreeJvmKt")
+package org.openrndr.extra.kdtree
+
+import kotlinx.coroutines.*
+
+@OptIn(DelicateCoroutinesApi::class)
+actual fun <T> buildKDTree(items: MutableList<T>, dimensions: Int, mapper: (T, Int) -> Double): KDTreeNode<T> {
+    val root = KDTreeNode<T>(dimensions, mapper)
+
+    fun <T> buildTreeTask(
+        scope: CoroutineScope,
+        node: KDTreeNode<T>,
+        items: MutableList<T>,
+        dimensions: Int,
+        levels: Int,
+        mapper: (T, Int) -> Double
+    ): KDTreeNode<T> {
+
+        if (items.size > 0) {
+            val dimension = levels % dimensions
+            val values = ArrayList<T>()
+            for (item in items) {
+                values.add(item)
+            }
+
+            node.dimension = dimension
+            val median = selectNth(items, items.size / 2) { mapper(it, dimension) }
+
+            val leftItems = mutableListOf<T>()
+            val rightItems = mutableListOf<T>()
+
+            node.median = mapper(median, dimension)
+            node.item = median
+            for (item in items) {
+                if (item === median) {
+                    continue
+                }
+                if (mapper(item, dimension) < node.median) {
+                    leftItems.add(item)
+                } else {
+                    rightItems.add(item)
+                }
+            }
+
+            // validate split
+            if (leftItems.size + rightItems.size + 1 != items.size) {
+                throw IllegalStateException("left: ${leftItems.size}, right: ${rightItems.size}, items: ${items.size}")
+            }
+
+            if (leftItems.size > 0) {
+                node.children[0] = KDTreeNode(dimensions, mapper)
+                node.children[0]?.let {
+                    it.parent = node
+
+                    scope.launch {
+                        buildTreeTask(scope, it, leftItems, dimensions, levels + 1, mapper)
+                    }
+                }
+            }
+            if (rightItems.size > 0) {
+                node.children[1] = KDTreeNode(dimensions, mapper)
+                node.children[1]?.let {
+                    it.parent = node
+                    scope.launch {
+                        buildTreeTask(scope, it, rightItems, dimensions, levels + 1, mapper)
+                    }
+                }
+            }
+        }
+        return node
+    }
+
+    val job = GlobalScope.launch {
+        buildTreeTask(this, root, items, dimensions, 0, mapper)
+    }
+    runBlocking {
+        job.join()
+    }
+    return root
+}