docs: add docs for pmap

universe-core/src/main/kotlin/relativitization/universe/core/utils/CoroutineUtils.kt

@@ -153,28 +153,35 @@ class CoroutineVar<T>(init: T) {
 
 
 /**
- * parallel map collection by coroutine
+ * Concurrently transform a collection into a list by coroutine
+ *
+ * @param f a function mapping an element in the collection into a new element
+ * @return A list containing the transformed elements
  */
 suspend fun <A, B> Collection<A>.pmap(f: suspend (A) -> B): List<B> = coroutineScope {
     withContext(Dispatchers.Default) {
-        /*
-        val threads = Thread.getAllStackTraces().keys.filter {
-            it.name.startsWith("CommonPool") || it.name.startsWith("ForkJoinPool")
-        }
-        println("Number of thread in coroutine: " + threads.size )
-        */
+        // A peace of code to test how many threads are being used
+        //val threads = Thread.getAllStackTraces().keys.filter {
+        //    it.name.startsWith("CommonPool") || it.name.startsWith("ForkJoinPool")
+        //}
+        //println("Number of thread in coroutine: ${threads.size}")
         map { async { f(it) } }.awaitAll()
     }
 }
 
+/**
+ * Concurrently transform a map into a list by coroutine
+ *
+ * @param f a function mapping the key and the value in the map into a new element
+ * @return A list containing the transformed elements
+ */
 suspend fun <K, V, B> Map<K, V>.pmap(f: suspend (K, V) -> B): List<B> = coroutineScope {
     withContext(Dispatchers.Default) {
-        /*
-        val threads = Thread.getAllStackTraces().keys.filter {
-            it.name.startsWith("CommonPool") || it.name.startsWith("ForkJoinPool")
-        }
-        println("Number of thread in coroutine: " + threads.size )
-        */
+        // A peace of code to test how many threads are being used
+        //val threads = Thread.getAllStackTraces().keys.filter {
+        //    it.name.startsWith("CommonPool") || it.name.startsWith("ForkJoinPool")
+        //}
+        //println("Number of thread in coroutine: ${threads.size}")
         map { async { f(it.key, it.value) } }.awaitAll()
     }
 }