Refactor list benchmark generators

Author: Abduqodiri Qurbonzoda

benchmarks-libraries/src/main/kotlin/generators/CommonUtilsGenerator.kt

@@ -18,7 +18,7 @@ package generators
 
 import java.io.PrintWriter
 
-class CommonUtilsGenerator: BenchmarkUtilsGenerator() {
+class CommonUtilsGenerator: UtilsSourceGenerator() {
     override val outputFileName: String = "utils"
 
     override fun generateBody(out: PrintWriter) {

benchmarks-libraries/src/main/kotlin/generators/IntWrapperGenerator.kt

@@ -18,7 +18,7 @@ package generators
 
 import java.io.PrintWriter
 
-class IntWrapperGenerator: BenchmarkUtilsGenerator() {
+class IntWrapperGenerator: UtilsSourceGenerator() {
     override val outputFileName: String = "IntWrapper"
 
     override fun generateBody(out: PrintWriter) {

benchmarks-libraries/src/main/kotlin/generators/benchmarkSourceGenerator.kt

@@ -36,18 +36,10 @@ import java.nio.file.Path
 import java.nio.file.Paths
 import javax.xml.xpath.XPathFactory
 
-abstract class BenchmarkSourceGenerator {
-    protected abstract fun generateBody(out: PrintWriter): Unit
-
+abstract class SourceGenerator {
     abstract val outputFileName: String
-
     open fun getPackage(): String = "benchmarks"
 
-    protected open val imports: Set<String> = setOf(
-            "org.openjdk.jmh.annotations.*",
-            "java.util.concurrent.TimeUnit"
-    )
-
     fun generate(out: PrintWriter) {
         out.println(readCopyrightNoticeFromProfile(File(".idea/copyright/apache_2_0.xml")))
         // Don't include generator class name in the message: these are built-in sources,
@@ -60,6 +52,22 @@ abstract class BenchmarkSourceGenerator {
             out.println("import $it")
         }
         out.println()
+
+        generateBody(out)
+    }
+
+    protected abstract val imports: Set<String>
+    protected abstract fun generateBody(out: PrintWriter): Unit
+}
+
+
+abstract class BenchmarkSourceGenerator: SourceGenerator() {
+    override val imports: Set<String> = setOf(
+            "org.openjdk.jmh.annotations.*",
+            "java.util.concurrent.TimeUnit"
+    )
+
+    override fun generateBody(out: PrintWriter) {
         out.println("""
 @Fork(1)
 @Warmup(iterations = 5)
@@ -69,34 +77,14 @@ abstract class BenchmarkSourceGenerator {
 @State(Scope.Thread)
         """.trimIndent()
         )
-
-        generateBody(out)
+        generateBenchmark(out)
     }
-}
 
-abstract class BenchmarkUtilsGenerator {
-    protected abstract fun generateBody(out: PrintWriter): Unit
-
-    abstract val outputFileName: String
-
-    open fun getPackage(): String = "benchmarks"
-
-    protected open val imports: Set<String> = setOf()
+    protected abstract fun generateBenchmark(out: PrintWriter)
+}
 
-    fun generate(out: PrintWriter) {
-        out.println(readCopyrightNoticeFromProfile(File(".idea/copyright/apache_2_0.xml")))
-        // Don't include generator class name in the message: these are built-in sources,
-        // and we don't want to scare users with any internal information about our project
-        out.println("// Auto-generated file. DO NOT EDIT!")
-        out.println()
-        out.println("package ${getPackage()}")
-        out.println()
-        imports.forEach {
-            out.println("import $it")
-        }
-        out.println()
-        generateBody(out)
-    }
+abstract class UtilsSourceGenerator: SourceGenerator() {
+    override val imports: Set<String> = setOf()
 }
 
 fun readCopyrightNoticeFromProfile(copyrightProfile: File): String {
@@ -114,12 +102,12 @@ private const val BENCHMARKS_ROOT = "src/jmh/java/"
 
 
 private val listImpls = listOf(
-        ListKotlinBenchmark(),
-        ListPaguroRrbTreeBenchmark(),
-        ListCyclopsBenchmark(),
-        ListClojureBenchmark(),
-        ListScalaBenchmark(),
-        ListVavrBenchmark()
+        KotlinListImplementation,
+        PaguroRrbTreeListImplementation,
+        CyclopsListImplementation,
+        ClojureListImplementation,
+        ScalaListImplementation,
+        VavrListImplementation
 )
 private val listBuilderImpls = listOf(
         ListBuilderKotlinBenchmark(),
@@ -175,13 +163,21 @@ private val setBuilderImpls = listOf(
 )
 
 fun generateBenchmarks() {
-    val listBenchmarks = listOf(
+    val listBenchmarks = listImpls.map { listOf(
+            ListAddBenchmarkGenerator(it),
+            ListGetBenchmarkGenerator(it),
+            ListIterateBenchmarkGenerator(it),
+            ListRemoveBenchmarkGenerator(it),
+            ListSetBenchmarkGenerator(it),
+            ListUtilsGenerator(it)
+    ) }
+    /*listOf(
             listImpls.filterIsInstance<ListAddBenchmark>().map { ListAddBenchmarkGenerator(it) },
             listImpls.filterIsInstance<ListGetBenchmark>().map { ListGetBenchmarkGenerator(it) },
             listImpls.filterIsInstance<ListIterateBenchmark>().map { ListIterateBenchmarkGenerator(it) },
             listImpls.filterIsInstance<ListRemoveBenchmark>().map { ListRemoveBenchmarkGenerator(it) },
             listImpls.filterIsInstance<ListSetBenchmark>().map { ListSetBenchmarkGenerator(it) }
-    )
+    )*/
     val listBuilderBenchmarks = listOf(
             listBuilderImpls.filterIsInstance<ListBuilderAddBenchmark>().map { ListBuilderAddBenchmarkGenerator(it) },
             listBuilderImpls.filterIsInstance<ListBuilderGetBenchmark>().map { ListBuilderGetBenchmarkGenerator(it) },
@@ -230,7 +226,6 @@ fun generateBenchmarks() {
 }
 
 fun generateUtils() {
-    val listUtils = listImpls.filterIsInstance<ListBenchmarkUtils>().map { ListUtilsGenerator(it) }
     val listBuilderUtils = listBuilderImpls.filterIsInstance<ListBuilderBenchmarkUtils>().map { ListBuilderUtilsGenerator(it) }
 
     val mapUtils = mapImpls.filterIsInstance<MapBenchmarkUtils>().map { MapUtilsGenerator(it) }
@@ -244,7 +239,7 @@ fun generateUtils() {
             CommonUtilsGenerator()
     )
 
-    val utils = listUtils + listBuilderUtils + mapUtils + mapBuilderUtils + setUtils + setBuilderUtils + commonUtils
+    val utils = listBuilderUtils + mapUtils + mapBuilderUtils + setUtils + setBuilderUtils + commonUtils
 
     utils.forEach { util ->
         val path = util.getPackage().replace('.', '/') + "/" + util.outputFileName + ".kt"

benchmarks-libraries/src/main/kotlin/generators/immutableList/addGenerator.kt

@@ -19,29 +19,23 @@ package generators.immutableList
 import generators.BenchmarkSourceGenerator
 import java.io.PrintWriter
 
-interface ListAddBenchmark {
-    val packageName: String
-    fun listType(T: String): String
-    val getOperation: String
-}
-
-class ListAddBenchmarkGenerator(private val impl: ListAddBenchmark) : BenchmarkSourceGenerator() {
-    override val outputFileName: String = "Add"
+class ListAddBenchmarkGenerator(private val impl: ListImplementation) : BenchmarkSourceGenerator() {
+    override val outputFileName: String get() = "Add"
 
     override fun getPackage(): String {
         return super.getPackage() + ".immutableList." + impl.packageName
     }
 
-    override val imports: Set<String> = super.imports + "org.openjdk.jmh.infra.Blackhole"
+    override val imports: Set<String> get() = super.imports + "org.openjdk.jmh.infra.Blackhole"
 
-    override fun generateBody(out: PrintWriter) {
+    override fun generateBenchmark(out: PrintWriter) {
         out.println("""
 open class Add {
     @Param("10000", "100000")
     var size: Int = 0
 
     @Benchmark
-    fun addLast(): ${impl.listType("String")} {
+    fun addLast(): ${impl.type()} {
         return persistentListAdd(size)
     }
 
@@ -57,7 +51,7 @@ open class Add {
     fun addLastAndGet(bh: Blackhole) {
         val list = persistentListAdd(size)
         for (i in 0 until size) {
-            bh.consume(list.${impl.getOperation}(i))
+            bh.consume(${impl.getOperation("list", "i")})
         }
     }
 }

benchmarks-libraries/src/main/kotlin/generators/immutableList/getGenerator.kt

@@ -19,28 +19,22 @@ package generators.immutableList
 import generators.BenchmarkSourceGenerator
 import java.io.PrintWriter
 
-interface ListGetBenchmark {
-    val packageName: String
-    fun emptyOf(T: String): String
-    val getOperation: String
-}
-
-class ListGetBenchmarkGenerator(private val impl: ListGetBenchmark) : BenchmarkSourceGenerator() {
-    override val outputFileName: String = "Get"
+class ListGetBenchmarkGenerator(private val impl: ListImplementation) : BenchmarkSourceGenerator() {
+    override val outputFileName: String get() = "Get"
 
     override fun getPackage(): String {
         return super.getPackage() + ".immutableList." + impl.packageName
     }
 
-    override val imports: Set<String> = super.imports + "org.openjdk.jmh.infra.Blackhole"
+    override val imports: Set<String> get() = super.imports + "org.openjdk.jmh.infra.Blackhole"
 
-    override fun generateBody(out: PrintWriter) {
+    override fun generateBenchmark(out: PrintWriter) {
         out.println("""
 open class Get {
     @Param("10000", "100000")
     var size: Int = 0
 
-    private var persistentList = ${impl.emptyOf("String")}
+    private var persistentList = ${impl.empty()}
 
     @Setup(Level.Trial)
     fun prepare() {
@@ -50,7 +44,7 @@ open class Get {
     @Benchmark
     fun getByIndex(bh: Blackhole) {
         for (i in 0 until size) {
-            bh.consume(persistentList.${impl.getOperation}(i))
+            bh.consume(${impl.getOperation("persistentList", "i")})
         }
     }
 }

benchmarks-libraries/src/main/kotlin/generators/immutableList/impl/clojure.kt

@@ -18,33 +18,26 @@ package generators.immutableList.impl
 
 import generators.immutableList.*
 
-class ListClojureBenchmark:
-        ListAddBenchmark,
-        ListGetBenchmark,
-        ListIterateBenchmark,
-        ListRemoveBenchmark,
-        ListSetBenchmark,
-        ListBenchmarkUtils
-{
+object ClojureListImplementation: ListImplementation {
     override val packageName: String = "clojure"
 
-    override fun listType(T: String): String = "clojure.lang.PersistentVector"
+    override fun type(): String = "clojure.lang.PersistentVector"
+    override fun empty(): String = "clojure.lang.PersistentVector.EMPTY"
 
-    override fun emptyOf(T: String): String = "clojure.lang.PersistentVector.EMPTY"
+    override fun getOperation(list: String, index: String): String
+            = "$list.get($index)"
+    override fun setOperation(list: String, index: String, newValue: String): String
+            = "$list.assocN($index, $newValue)"
+    override fun addOperation(list: String, element: String): String
+            = "$list.cons($element)"
+    override fun removeLastOperation(list: String): String
+            = "$list.pop()"
 
-    override fun addOperation(list: String, T: String, element: String): String = "$list.cons($element)"
-
-    override fun removeAtOperation(list: String): String = "pop()"
-
-    override val getOperation: String = "get"
-
-    override val setOperation: String = "assocN"
-
-    override fun iterateLastToFirst(list: String): String {
+    override fun iterateLastToFirst(list: String, size: String): String {
         return """
     @Benchmark
     fun lastToFirst(bh: Blackhole) {
-        val iterator = $list.listIterator(size)
+        val iterator = $list.listIterator($size)
 
         while (iterator.hasPrevious()) {
             bh.consume(iterator.previous())

benchmarks-libraries/src/main/kotlin/generators/immutableList/impl/cyclops.kt

@@ -18,29 +18,22 @@ package generators.immutableList.impl
 
 import generators.immutableList.*
 
-class ListCyclopsBenchmark:
-        ListAddBenchmark,
-        ListGetBenchmark,
-        ListIterateBenchmark,
-        ListRemoveBenchmark,
-        ListSetBenchmark,
-        ListBenchmarkUtils
-{
+object CyclopsListImplementation: ListImplementation {
     override val packageName: String = "cyclops"
 
-    override fun listType(T: String): String = "cyclops.data.Vector<$T>"
+    override fun type(): String = "cyclops.data.Vector<$listElementType>"
+    override fun empty(): String = "cyclops.data.Vector.empty<$listElementType>()"
 
-    override fun emptyOf(T: String): String = "cyclops.data.Vector.empty<$T>()"
+    override fun getOperation(list: String, index: String): String
+            = "$list.get($index)"
+    override fun setOperation(list: String, index: String, newValue: String): String
+            = "$list.updateAt($index, $newValue)"
+    override fun addOperation(list: String, element: String): String
+            = "$list.plus($element)"
+    override fun removeLastOperation(list: String): String
+            = "$list.dropRight(1)"
 
-    override fun addOperation(list: String, T: String, element: String): String = "$list.plus($element)"
-
-    override fun removeAtOperation(list: String): String = "dropRight(1)"
-
-    override val getOperation: String = "get"
-
-    override val setOperation: String = "updateAt"
-
-    override fun iterateLastToFirst(list: String): String {
+    override fun iterateLastToFirst(list: String, size: String): String {
         return """
     @Benchmark
     fun lastToFirst(bh: Blackhole) {

benchmarks-libraries/src/main/kotlin/generators/immutableList/impl/kotlin.kt

@@ -18,33 +18,26 @@ package generators.immutableList.impl
 
 import generators.immutableList.*
 
-class ListKotlinBenchmark:
-        ListAddBenchmark,
-        ListGetBenchmark,
-        ListIterateBenchmark,
-        ListRemoveBenchmark,
-        ListSetBenchmark,
-        ListBenchmarkUtils
-{
+object KotlinListImplementation: ListImplementation {
     override val packageName: String = "kotlin"
 
-    override fun listType(T: String): String = "kotlinx.collections.immutable.PersistentList<$T>"
+    override fun type(): String = "kotlinx.collections.immutable.PersistentList<$listElementType>"
+    override fun empty(): String = "kotlinx.collections.immutable.persistentListOf<$listElementType>()"
 
-    override fun emptyOf(T: String): String = "kotlinx.collections.immutable.persistentListOf<$T>()"
+    override fun getOperation(list: String, index: String): String
+            = "$list.get($index)"
+    override fun setOperation(list: String, index: String, newValue: String): String
+            = "$list.set($index, $newValue)"
+    override fun addOperation(list: String, element: String): String
+            = "$list.add($element)"
+    override fun removeLastOperation(list: String): String
+            = "$list.removeAt($list.size - 1)"
 
-    override fun addOperation(list: String, T: String, element: String): String = "$list.add($element)"
-
-    override fun removeAtOperation(list: String): String = "removeAt($list.size - 1)"
-
-    override val getOperation: String = "get"
-
-    override val setOperation: String = "set"
-
-    override fun iterateLastToFirst(list: String): String {
+    override fun iterateLastToFirst(list: String, size: String): String {
         return """
     @Benchmark
     fun lastToFirst(bh: Blackhole) {
-        val iterator = $list.listIterator(size)
+        val iterator = $list.listIterator($size)
 
         while (iterator.hasPrevious()) {
             bh.consume(iterator.previous())