Add info about benchmark measurements

Author: Abduqodiri Qurbonzoda

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

@@ -29,6 +29,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list.
      *
+     * Measures mean time and memory spent per `add` operation.
+     *
      * Expected time: nearly constant.
      * Expected memory: for size in 1..32 - O(size), nearly constant otherwise.
      */
@@ -40,6 +42,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list and then iterates all elements from first to last.
      *
+     * Measures mean time and memory spent per `add` and `next` operations.
+     *
      * Expected time: [addLast] + [Iterate.firstToLast]
      * Expected memory: [addLast] + [Iterate.firstToLast]
      */
@@ -54,6 +58,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list and then gets all elements by index from first to last.
      *
+     * Measures mean time and memory spent per `add` and `get` operations.
+     *
      * Expected time: [addLast] + [Get.getByIndex]
      * Expected memory: [addLast] + [Get.getByIndex]
      */

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

@@ -37,6 +37,8 @@ open class Get {
     /**
      * Gets every element by index starting from first to last.
      *
+     * Measures mean time and memory spent per `get` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */

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

@@ -37,6 +37,8 @@ open class Iterate {
     /**
      * Iterates every element starting from first to last.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant
      * Expected memory: none once iterator created
      */
@@ -50,6 +52,8 @@ open class Iterate {
     /**
      * Iterates every element starting from last to first.
      *
+     * Measures mean time and memory spent per `previous` operation.
+     *
      * Expected time: nearly constant
      * Expected memory: none once iterator created
      */

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

@@ -37,6 +37,8 @@ open class Remove {
     /**
      * Removes all elements by index starting from last to first.
      *
+     * Measures mean time and memory spent per `removeAt` operation.
+     *
      * Expected time: nearly constant.
      * Expected memory: for size in 1..32 - O(size), nearly constant otherwise.
      */

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

@@ -39,6 +39,8 @@ open class Set {
     /**
      * Updates each element by index starting from first to last.
      *
+     * Measures mean time and memory spent per `set` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */
@@ -53,6 +55,8 @@ open class Set {
     /**
      * Updates each element by index randomly.
      *
+     * Measures mean time and memory spent per `set` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */

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

@@ -32,6 +32,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list builder.
      *
+     * Measures mean time and memory spent per `add` operation.
+     *
      * Expected time: nearly constant.
      * Expected memory: nearly constant.
      */
@@ -43,6 +45,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list builder and then iterates all elements from first to last.
      *
+     * Measures mean time and memory spent per `add` and `next` operations.
+     *
      * Expected time: [addLast] + [Iterate.firstToLast]
      * Expected memory: [addLast] + [Iterate.firstToLast]
      */
@@ -57,6 +61,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent list builder and then gets all elements by index from first to last.
      *
+     * Measures mean time and memory spent per `add` and `get` operations.
+     *
      * Expected time: [addLast] + [Get.getByIndex]
      * Expected memory: [addLast] + [Get.getByIndex]
      */

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

@@ -39,6 +39,8 @@ open class Get {
     /**
      * Gets every element by index starting from first to last.
      *
+     * Measures mean time and memory spent per `get` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */

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

@@ -39,6 +39,8 @@ open class Iterate {
     /**
      * Iterates every element starting from first to last.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant
      * Expected memory: none once iterator created
      */
@@ -52,6 +54,8 @@ open class Iterate {
     /**
      * Iterates every element starting from last to first.
      *
+     * Measures mean time and memory spent per `previous` operation.
+     *
      * Expected time: nearly constant
      * Expected memory: none once iterator created
      */

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

@@ -31,6 +31,8 @@ open class Remove {
     /**
      * Adds [size] elements to an empty persistent list builder and then removes each element by index starting from last to first.
      *
+     * Measures mean time and memory spent per `add` and `removeAt` operations.
+     *
      * Expected time: [Add.addLast] + nearly constant.
      * Expected memory: [Add.addLast] + nearly constant.
      */

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

@@ -41,6 +41,8 @@ open class Set {
     /**
      * Updates each element by index starting from first to last.
      *
+     * Measures mean time and memory spent per `set` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: nearly constant
      */
@@ -55,6 +57,8 @@ open class Set {
     /**
      * Updates each element by index randomly.
      *
+     * Measures mean time and memory spent per `set` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: nearly constant
      */

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

@@ -47,6 +47,8 @@ open class Get {
     /**
      * Gets every value by key.
      *
+     * Measures mean time and memory spent per `get` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */

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

@@ -42,6 +42,8 @@ open class Iterate {
     /**
      * Iterates all keys.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: none once iterator is created.
      */
@@ -55,6 +57,8 @@ open class Iterate {
     /**
      * Iterates all values.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: none once iterator is created.
      */
@@ -68,6 +72,8 @@ open class Iterate {
     /**
      * Iterates all entries.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: constant.
      */

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

@@ -42,6 +42,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map.
      *
+     * Measures mean time and memory spent per `put` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */
@@ -53,6 +55,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map and then gets every value by key.
      *
+     * Measures mean time and memory spent per `put` and `get` operations.
+     *
      * Expected time: [put] + [Get.get]
      * Expected memory: [put] + [Get.get]
      */
@@ -67,6 +71,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map and then iterates all keys.
      *
+     * Measures mean time and memory spent per `put` and `next` operations.
+     *
      * Expected time: [put] + [Iterate.iterateKeys]
      * Expected memory: [put] + [Iterate.iterateKeys]
      */

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

@@ -47,6 +47,8 @@ open class Remove {
     /**
      * Removes each entry by key.
      *
+     * Measures mean time and memory spent per `remove` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */

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

@@ -50,6 +50,8 @@ open class Get {
     /**
      * Gets every value by key.
      *
+     * Measures mean time and memory spent per `get` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */

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

@@ -46,6 +46,8 @@ open class Iterate {
     /**
      * Iterates all keys.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: none once iterator is created.
      */
@@ -59,6 +61,8 @@ open class Iterate {
     /**
      * Iterates all values.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: constant.
      */
@@ -72,6 +76,8 @@ open class Iterate {
     /**
      * Iterates all entries.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: constant.
      */

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

@@ -45,6 +45,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map builder.
      *
+     * Measures mean time and memory spent per `put` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */
@@ -56,6 +58,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map builder and then gets every value by key.
      *
+     * Measures mean time and memory spent per `put` and `get` operations.
+     *
      * Expected time: [put] + [Get.get]
      * Expected memory: [put] + [Get.get]
      */
@@ -70,6 +74,8 @@ open class Put {
     /**
      * Adds [size] entries to an empty persistent map builder and then iterates all keys.
      *
+     * Measures mean time and memory spent per `put` and `next` operations.
+     *
      * Expected time: [put] + [Iterate.iterateKeys]
      * Expected memory: [put] + [Iterate.iterateKeys]
      */

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

@@ -51,6 +51,8 @@ open class Remove {
     /**
      * Adds [size] entries to an empty persistent map builder and then removes each entry by key.
      *
+     * Measures mean time and memory spent per `put` and `remove` operations.
+     *
      * Expected time: [Put.put] + logarithmic
      * Expected memory: [Put.put] + logarithmic
      */

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

@@ -42,6 +42,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set.
      *
+     * Measures mean time and memory spent per `add` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */
@@ -53,6 +55,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set and then requests if every element is contained.
      *
+     * Measures mean time and memory spent per `add` and `contains` operations.
+     *
      * Expected time: [add] + [Contains.contains]
      * Expected memory: [add] + [Contains.contains]
      */
@@ -67,6 +71,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set and then iterates all elements.
      *
+     * Measures mean time and memory spent per `add` and `next` operations.
+     *
      * Expected time: [add] + [Iterate.iterate]
      * Expected memory: [add] + [Iterate.iterate]
      */

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableSet/Contains.kt

@@ -47,6 +47,8 @@ open class Contains {
     /**
      * Requests if every element is contained.
      *
+     * Measures mean time and memory spent per `contains` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */

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

@@ -42,6 +42,8 @@ open class Iterate {
     /**
      * Iterates all elements.
      *
+     * Measures mean time and memory spent per `next` operation.
+     *
      * Expected time: nearly constant (logarithmic for ordered persistent map)
      * Expected memory: none once iterator is created.
      */

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

@@ -47,6 +47,8 @@ open class Remove {
     /**
      * Removes each element.
      *
+     * Measures mean time and memory spent per `remove` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */

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

@@ -45,6 +45,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set builder.
      *
+     * Measures mean time and memory spent per `add` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: logarithmic
      */
@@ -56,6 +58,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set builder and then requests if every element is contained.
      *
+     * Measures mean time and memory spent per `add` and `contains` operations.
+     *
      * Expected time: [add] + [Contains.contains]
      * Expected memory: [add] + [Contains.contains]
      */
@@ -70,6 +74,8 @@ open class Add {
     /**
      * Adds [size] elements to an empty persistent set builder and then iterates all elements.
      *
+     * Measures mean time and memory spent per `add` and `next` operations.
+     *
      * Expected time: [add] + [Iterate.iterate]
      * Expected memory: [add] + [Iterate.iterate]
      */

benchmarks-mpp/src/jvmMain/kotlin/benchmarks/immutableSet/builder/Contains.kt

@@ -50,6 +50,8 @@ open class Contains {
     /**
      * Requests if every element is contained.
      *
+     * Measures mean time and memory spent per `contains` operation.
+     *
      * Expected time: logarithmic
      * Expected memory: none
      */