Comment benchmark methods

Author: Abduqodiri Qurbonzoda

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/Add.kt

@@ -26,11 +26,23 @@ open class Add {
     @Param(BM_1, BM_10, BM_100, BM_1000, BM_10000, BM_100000, BM_1000000, BM_10000000)
     var size: Int = 0
 
+    /**
+     * Adds [size] elements to an empty persistent list.
+     *
+     * Expected time: nearly constant.
+     * Expected memory: for size in 1..32 - O(size), nearly constant otherwise.
+     */
     @Benchmark
     fun addLast(): ImmutableList<String> {
         return persistentListAdd(size)
     }
 
+    /**
+     * Adds [size] elements to an empty persistent list and then iterates all elements from first to last.
+     *
+     * Expected time: [addLast] + [Iterate.firstToLast]
+     * Expected memory: [addLast] + [Iterate.firstToLast]
+     */
     @Benchmark
     fun addLastAndIterate(bh: Blackhole) {
         val list = persistentListAdd(size)
@@ -39,6 +51,12 @@ open class Add {
         }
     }
 
+    /**
+     * Adds [size] elements to an empty persistent list and then gets all elements by index from first to last.
+     *
+     * Expected time: [addLast] + [Get.getByIndex]
+     * Expected memory: [addLast] + [Get.getByIndex]
+     */
     @Benchmark
     fun addLastAndGet(bh: Blackhole) {
         val list = persistentListAdd(size)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/Get.kt

@@ -34,6 +34,12 @@ open class Get {
         persistentList = persistentListAdd(size)
     }
 
+    /**
+     * Gets every element by index starting from first to last.
+     *
+     * Expected time: logarithmic
+     * Expected memory: none
+     */
     @Benchmark
     fun getByIndex(bh: Blackhole) {
         for (i in 0 until persistentList.size) {

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/Iterate.kt

@@ -34,13 +34,25 @@ open class Iterate {
         persistentList = persistentListAdd(size)
     }
 
+    /**
+     * Iterates every element starting from first to last.
+     *
+     * Expected time: nearly constant
+     * Expected memory: none once iterator created
+     */
     @Benchmark
     fun firstToLast(bh: Blackhole) {
         for (e in persistentList) {
             bh.consume(e)
         }
     }
 
+    /**
+     * Iterates every element starting from last to first.
+     *
+     * Expected time: nearly constant
+     * Expected memory: none once iterator created
+     */
     @Benchmark
     fun lastToFirst(bh: Blackhole) {
         val iterator = persistentList.listIterator(size)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/Remove.kt

@@ -34,6 +34,12 @@ open class Remove {
         persistentList = persistentListAdd(size)
     }
 
+    /**
+     * Removes all elements by index starting from last to first.
+     *
+     * Expected time: nearly constant.
+     * Expected memory: for size in 1..32 - O(size), nearly constant otherwise.
+     */
     @Benchmark
     fun removeLast(): ImmutableList<String> {
         var list = persistentList

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/Set.kt

@@ -36,6 +36,12 @@ open class Set {
         randomIndices = List(size) { it }.shuffled()
     }
 
+    /**
+     * Updates each element by index starting from first to last.
+     *
+     * Expected time: logarithmic
+     * Expected memory: logarithmic
+     */
     @Benchmark
     fun setByIndex(): ImmutableList<String> {
         repeat(times = size) { index ->
@@ -44,6 +50,12 @@ open class Set {
         return persistentList
     }
 
+    /**
+     * Updates each element by index randomly.
+     *
+     * Expected time: logarithmic
+     * Expected memory: logarithmic
+     */
     @Benchmark
     fun setByRandomIndex(): ImmutableList<String> {
         repeat(times = size) { index ->

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/builder/Add.kt

@@ -29,11 +29,23 @@ open class Add {
     @Param(IP_100, IP_99_09, IP_95, IP_70, IP_50, IP_30, IP_0)
     var immutablePercentage: Double = 0.0
 
+    /**
+     * Adds [size] elements to an empty persistent list builder.
+     *
+     * Expected time: nearly constant.
+     * Expected memory: nearly constant.
+     */
     @Benchmark
     fun addLast(): PersistentList.Builder<String> {
         return persistentListBuilderAdd(size, immutablePercentage)
     }
 
+    /**
+     * Adds [size] elements to an empty persistent list builder and then iterates all elements from first to last.
+     *
+     * Expected time: [addLast] + [Iterate.firstToLast]
+     * Expected memory: [addLast] + [Iterate.firstToLast]
+     */
     @Benchmark
     fun addLastAndIterate(bh: Blackhole) {
         val builder = persistentListBuilderAdd(size, immutablePercentage)
@@ -42,6 +54,12 @@ open class Add {
         }
     }
 
+    /**
+     * Adds [size] elements to an empty persistent list builder and then gets all elements by index from first to last.
+     *
+     * Expected time: [addLast] + [Get.getByIndex]
+     * Expected memory: [addLast] + [Get.getByIndex]
+     */
     @Benchmark
     fun addLastAndGet(bh: Blackhole) {
         val builder = persistentListBuilderAdd(size, immutablePercentage)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/builder/Get.kt

@@ -36,6 +36,12 @@ open class Get {
         builder = persistentListBuilderAdd(size, immutablePercentage)
     }
 
+    /**
+     * Gets every element by index starting from first to last.
+     *
+     * Expected time: logarithmic
+     * Expected memory: none
+     */
     @Benchmark
     fun getByIndex(bh: Blackhole) {
         for (i in 0 until builder.size) {

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/builder/Iterate.kt

@@ -36,13 +36,25 @@ open class Iterate {
         builder = persistentListBuilderAdd(size, immutablePercentage)
     }
 
+    /**
+     * Iterates every element starting from first to last.
+     *
+     * Expected time: nearly constant
+     * Expected memory: none once iterator created
+     */
     @Benchmark
     fun firstToLast(bh: Blackhole) {
         for (e in builder) {
             bh.consume(e)
         }
     }
 
+    /**
+     * Iterates every element starting from last to first.
+     *
+     * Expected time: nearly constant
+     * Expected memory: none once iterator created
+     */
     @Benchmark
     fun lastToFirst(bh: Blackhole) {
         val iterator = builder.listIterator(size)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/builder/Remove.kt

@@ -28,6 +28,12 @@ open class Remove {
     @Param(IP_100, IP_99_09, IP_95, IP_70, IP_50, IP_30, IP_0)
     var immutablePercentage: Double = 0.0
 
+    /**
+     * Adds [size] elements to an empty persistent list builder and then removes each element by index starting from last to first.
+     *
+     * Expected time: [Add.addLast] + nearly constant.
+     * Expected memory: [Add.addLast] + nearly constant.
+     */
     @Benchmark
     fun addAndRemoveLast(): PersistentList.Builder<String> {
         val builder = persistentListBuilderAdd(size, immutablePercentage)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableList/builder/Set.kt

@@ -38,6 +38,12 @@ open class Set {
         randomIndices = List(size) { it }.shuffled()
     }
 
+    /**
+     * Updates each element by index starting from first to last.
+     *
+     * Expected time: logarithmic
+     * Expected memory: nearly constant
+     */
     @Benchmark
     fun setByIndex(): PersistentList.Builder<String> {
         for (i in 0 until size) {
@@ -46,6 +52,12 @@ open class Set {
         return builder
     }
 
+    /**
+     * Updates each element by index randomly.
+     *
+     * Expected time: logarithmic
+     * Expected memory: nearly constant
+     */
     @Benchmark
     fun setByRandomIndex(): PersistentList.Builder<String> {
         for (i in 0 until size) {

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/Get.kt

@@ -44,6 +44,12 @@ open class Get {
             keys = generateKeys(hashCodeType, size)
     }
 
+    /**
+     * Gets every value by key.
+     *
+     * Expected time: logarithmic
+     * Expected memory: none
+     */
     @Benchmark
     fun get(bh: Blackhole) {
         repeat(times = size) { index ->

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/Iterate.kt

@@ -39,20 +39,38 @@ open class Iterate {
         persistentMap = persistentMapPut(implementation, generateKeys(hashCodeType, size))
     }
 
+    /**
+     * Iterates all keys.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: none once iterator is created.
+     */
     @Benchmark
     fun iterateKeys(bh: Blackhole) {
         for (k in persistentMap.keys) {
             bh.consume(k)
         }
     }
 
+    /**
+     * Iterates all values.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: none once iterator is created.
+     */
     @Benchmark
     fun iterateValues(bh: Blackhole) {
         for (v in persistentMap.values) {
             bh.consume(v)
         }
     }
 
+    /**
+     * Iterates all entries.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: constant.
+     */
     @Benchmark
     fun iterateEntries(bh: Blackhole) {
         for (e in persistentMap) {

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/Put.kt

@@ -39,11 +39,23 @@ open class Put {
         keys = generateKeys(hashCodeType, size)
     }
 
+    /**
+     * Adds [size] entries to an empty persistent map.
+     *
+     * Expected time: logarithmic
+     * Expected memory: logarithmic
+     */
     @Benchmark
     fun put(): PersistentMap<IntWrapper, String> {
         return persistentMapPut(implementation, keys)
     }
 
+    /**
+     * Adds [size] entries to an empty persistent map and then gets every value by key.
+     *
+     * Expected time: [put] + [Get.get]
+     * Expected memory: [put] + [Get.get]
+     */
     @Benchmark
     fun putAndGet(bh: Blackhole) {
         val map = persistentMapPut(implementation, keys)
@@ -52,6 +64,12 @@ open class Put {
         }
     }
 
+    /**
+     * Adds [size] entries to an empty persistent map and then iterates all keys.
+     *
+     * Expected time: [put] + [Iterate.iterateKeys]
+     * Expected memory: [put] + [Iterate.iterateKeys]
+     */
     @Benchmark
     fun putAndIterateKeys(bh: Blackhole) {
         val map = persistentMapPut(implementation, keys)

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/Remove.kt

@@ -44,6 +44,12 @@ open class Remove {
             keys = generateKeys(hashCodeType, size)
     }
 
+    /**
+     * Removes each entry by key.
+     *
+     * Expected time: logarithmic
+     * Expected memory: logarithmic
+     */
     @Benchmark
     fun remove(): PersistentMap<IntWrapper, String> {
         var map = persistentMap

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/builder/Get.kt

@@ -47,6 +47,12 @@ open class Get {
             keys = generateKeys(hashCodeType, size)
     }
 
+    /**
+     * Gets every value by key.
+     *
+     * Expected time: logarithmic
+     * Expected memory: none
+     */
     @Benchmark
     fun get(bh: Blackhole) {
         repeat(times = size) { index ->

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableMap/builder/Iterate.kt

@@ -43,20 +43,38 @@ open class Iterate {
         builder = persistentMapBuilderPut(implementation, keys, immutablePercentage)
     }
 
+    /**
+     * Iterates all keys.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: none once iterator is created.
+     */
     @Benchmark
     fun iterateKeys(bh: Blackhole) {
         for (k in builder.keys) {
             bh.consume(k)
         }
     }
 
+    /**
+     * Iterates all values.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: constant.
+     */
     @Benchmark
     fun iterateValues(bh: Blackhole) {
         for (v in builder.values) {
             bh.consume(v)
         }
     }
 
+    /**
+     * Iterates all entries.
+     *
+     * Expected time: nearly constant (logarithmic for ordered persistent map)
+     * Expected memory: constant.
+     */
     @Benchmark
     fun iterateEntries(bh: Blackhole) {
         for (e in builder) {